Skip to main content
Credal | Documentation
current

Search documentation

Type to search this documentation.

On this pageOverview

Update Configuration

POST https://api.credal.ai/api/v0/copilots/updateConfiguration Content-Type: application/json

Update the configuration for a agent

Reference: https://docs.credal.ai/api-reference/api-reference/copilots/update-configuration

  • Authorization header (bearer token, required) — Bearer authentication of the form Bearer <token>, where token is your auth token.

Body (application/json)

This endpoint expects an object.

  • copilotId (UUID, required) — Credal-generated agent ID to add the collection to.
  • configuration (Configuration, required)

Types

  • name (string, optional)
  • description (string, optional)
  • prompt (string, optional)

Examples

Request

JSON
{
  "copilotId": "82e4b12a-6990-45d4-8ebd-85c00e030c24",
  "configuration": {
    "name": "Customer Agent",
    "description": "This agent is used to answer customer requests based on internal documentation.",
    "prompt": "You are a polite, helpful assistant used to answer customer requests."
  }
}
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu