Agents

Create a new agent.

Create a new agent by importing data either from a sitemap or an uploaded file. This endpoint enables you to initiate the creation of a new agent by supplying the necessary agent data that will be used as the context. You can choose to import the agent knowledge and content from a sitemap url or upload a specific file format that contains the context can be any text, audio or video format. The system will process the provided data and generate a new agent based on the imported or uploaded information. Here is an example to create an agent using a sitemap: API SDK.

post/api/v1/projects

Response

Agent has been created

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

Changed in 4 of the 9 revisions of this API.22230

Jul 17, 2026b80e6dfcf78d29See the full diff
- ●
  added the new Agent name can't be empty enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new You have reached your agent limit enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  api tag Agents added
  api-tag-added
- ○
  api tag Projects removed
  api-tag-removed
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  removed the Project name can't be empty enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the You have reached your monthly project limit enum value from the / response property for the response status
  response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 12, 20231675fc6aa16a114See the full diff
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Jun 15, 2023754bec1d3aae11See the full diff
- ▲
  removed the media type application/json from the request body
  request-body-media-type-removed
- ○
  added the media type multipart/form-data to the request body
  request-body-media-type-added
Jun 2, 20231842d7fd04301196See the full diff
- ▲
  removed the media type multipart/form-data from the request body
  request-body-media-type-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  added the new Project name can't be empty enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new You have reached your monthly project limit enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  api tag Projects added
  api-tag-added
- ○
  api tag Agents removed
  api-tag-removed
- ○
  added the media type application/json to the request body
  request-body-media-type-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  removed the Agent name can't be empty enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the You have reached your agent limit enum value from the / response property for the response status
  response-property-enum-value-removed
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history