Agents

Create an agent.

Changed on

Creates a new agent by importing content from a sitemap URL or uploading a file. The imported content becomes the agent's knowledge base, which it uses to answer questions. The agent will begin processing the content immediately after creation.

Notes: Processing time depends on the amount of content. Check the agent's status to know when it's ready.

post/api/v1/projects

Request

Request body multipart/form-data

project_namestring

Agent name

is_masterboolean

Whether this agent is a master agent. Can only be set at creation time — cannot be changed afterwards.

sitemap_pathstring

Supports YouTube, Vimeo, sitemaps, and websites.

file_data_retensionboolean

File data retension

is_ocr_enabled0 | 1 | 2

OCR processing mode: 0 = Disabled, 1 = OCR enabled, 2 = AI Vision

is_anonymizedboolean

Anonymized

is_vision_enabledboolean

Whether to enable vision processing for images in the file source.

is_vision_compress_imageboolean

Whether to compress images for vision processing.

use_planner_modeboolean

Whether to enable Plan & Act mode for this agent. Defaults to false.

filestring binary

Single file upload. Discouraged - use files[] instead for new integrations.

files[]string[]

Multiple file uploads. Submit each file as a separate files[] part in multipart/form-data. Up to 50 files per request, max 100MB each, max 1GB total batch size.

is_low_performance_mode_enabledboolean

Use a lower-performance crawl mode that is less likely to be blocked by websites with aggressive bot protection.

allow_extra_timeoutboolean

Allow extra processing time when crawling slow or large sources.

use_full_url_crawlboolean

Crawl every URL discovered on the site rather than relying solely on the sitemap.

image_extraction_type'none' | 'sync_from_sitemap' | 'extract_opengraph_images'

The method used for extracting images from the website.

Example request

{
  "project_name": "Support Assistant",
  "sitemap_path": "https://example.com/sitemap.xml",
  "is_anonymized": 0
}

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

    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from boolean to integer

    • 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 new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new 0.00 enum value to the request property

    • info

      added the new 1.00 enum value to the request property

    • info

      added the new 2.00 enum value to the request property

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • warning

      added the new Agent name can't be empty enum value to the / response property for the response status

    • warning

      added the new You have reached your agent limit enum value to the / response property for the response status

    • info

      api tag Agents added

    • info

      api tag Projects removed

    • info

      added the new optional request property

    • info

      added the new optional request property

    • 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 name can't be empty enum value from the / response property for the response status

    • info

      removed the You have reached your monthly project limit enum value from the / response property for the response status