v1

latestOpenAPI 3.0.22026-07-174617345.8 KB

Agents

Show a certain agent.

Retrieve details of an agent (formerly known as project) based on its unique project ID. This endpoint allows you to fetch specific information about an agent.

get/api/v1/projects/{projectId}

Path parameters

projectIdinteger required

Example:1

The unique agent identifier.

Query parameters

widthstring

Example:50rem

The width of the embed code. Defaults to 100%.

heightstring

Example:50rem

The height of the embed code. Defaults to 100%.

Response

Retrieve certain agent that belongs to the user

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "id": 1,
    "project_name": "My Agent",
    "sitemap_path": "https://www.example.com/sitemap.xml",
    "is_chat_active": true,
    "user_id": 1,
    "team_id": 1,
    "created_at": "2021-01-01 00:00:00",
    "updated_at": "2021-01-01 00:00:00",
    "deleted_at": "2021-01-01 00:00:00",
    "type": "SITEMAP",
    "is_shared": true,
    "shareable_slug": "1234567890abcdef1234567890abcdef",
    "are_licenses_allowed": true
  }
}