Get Conversations

GET 
/api/conversations

This endpoint retrieves conversations from a specified workspace. The request must include a valid API key and user ID.

Request

Query Parameters

workspaceId stringrequired

ID of the workspace whose conversations are being retrieved.

Header Parameters

x-api-key stringrequired

API key to authorize the request.

userId stringrequired

ID of the user making the request.

Responses

200

Successfully retrieved conversations.

application/json

Schema

Schema

conversations

object[]

Array [

conversationid string

The ID of the conversation.

createdat date-time

The timestamp when the conversation was created.

name string

The name of the conversation.

ownerid string

The ID of the owner of the conversation.

]

Example (from schema)

{
  "conversations": [
    {
      "conversationid": "string",
      "createdat": "2024-12-12T17:23:19.610Z",
      "name": "string",
      "ownerid": "string"
    }
  ]
}

400

There has been a problem with your fetch operation.

application/json

Schema

Schema

error string

Error message indicating that there was a problem with the fetch operation.

Example (from schema)

{
  "error": "string"
}

403

Invalid API key.

application/json

Schema

Schema

error

object

message string

Detailed error message indicating that the API key is invalid.

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

404

Workspace not found.

application/json

Schema

Schema

error

object

message string

Error message indicating that the workspace was not found.

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

500

Internal server error.

application/json

Schema

Schema

message string

Error message indicating an internal server error.

Example (from schema)

{
  "message": "string"
}

Loading...