All API categories

    Public API API

    4 endpoints

    Public-facing, unauthenticated endpoints.

    POST
    Auth Required

    Generate text-to-speech audio / export async function generate( collectionId: string, request: TTSRequest ): Promise<Blo

    Generate text-to-speech audio / export async function generate( collectionId: string, request: TTSRequest ): Promise<Blo

    Endpoint

    /public/collection/{collectionId}/ai/chat

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    PublicChatRequest
    Required

    See PublicChatRequest schema

    Responses

    200
    Success
    {
  "schema": "PublicChatResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Get session history / export async function getSession(collectionId: string, sessionId: string): Promise<Session> { cons

    Get session history / export async function getSession(collectionId: string, sessionId: string): Promise<Session> { cons

    Endpoint

    /public/collection/{collectionId}/ai/rate-limit/{userId}

    Parameters

    collectionId
    path
    string
    Required
    userId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "RateLimitStatus"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Chat with product assistant (RAG) / export async function chat( collectionId: string, request: PublicChatRequest ): Prom

    Chat with product assistant (RAG) / export async function chat( collectionId: string, request: PublicChatRequest ): Prom

    Endpoint

    /public/collection/{collectionId}/ai/session/{sessionId}

    Parameters

    collectionId
    path
    string
    Required
    sessionId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "Session"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Clear session history / export async function clearSession(collectionId: string, sessionId: string): Promise<{ success:

    Clear session history / export async function clearSession(collectionId: string, sessionId: string): Promise<{ success:

    Endpoint

    /public/collection/{collectionId}/ai/token

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    EphemeralTokenRequest
    Required

    See EphemeralTokenRequest schema

    Responses

    200
    Success
    {
  "schema": "EphemeralTokenResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found