POpoll-the-people
Agents

Get agent details.

Changed on

Returns the full configuration and current status for a specific agent. Use this to check processing status, view settings, or retrieve metadata about the agent.

get/api/v1/projects/{projectId}

Request

Path parameters

projectIdinteger required
Example:1

The unique identifier of the agent to retrieve. Obtain agent IDs from the response of GET /api/v1/projects or POST /api/v1/projects.

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
  }
}

Changes

  • 77aab4354382Revision changes
    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

  • b80e6dfcf78dRevision changes
    • warning

      added the new Agent id is required enum value to the / response property for the response status

    • warning

      added the new Agent with id {projectId} not found enum value to the / response property for the response status

    • info

      api tag Agents added

    • info

      api tag Projects removed

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      removed the Project id is required enum value from the / response property for the response status

    • info

      removed the Project with id {projectId} not found enum value from the / response property for the response status