Sign in
Agents

Import agent configuration

Create a new agent configuration from a JSON body matching the agent config schema.

post/api/v1/w/{wId}/assistant/agent_configurations/import

Path parameters

wIdstring required

ID of the workspace

Request body

instructionsstring required
editorsstring[] required

Emails of the workspace members to set as editors of the agent.

Example request

{
  "editors": [
    "alice@example.com"
  ]
}

Response

Successfully created agent configuration

Example response

{
  "agentConfiguration": {
    "id": 12345,
    "sId": "7f3a9c2b1e",
    "version": 2,
    "versionCreatedAt": "2023-06-15T14:30:00Z",
    "versionAuthorId": "0ec9852c2f",
    "name": "Customer Support Agent",
    "description": "An AI agent designed to handle customer support inquiries",
    "instructions": "Always greet the customer politely and try to resolve their issue efficiently.",
    "pictureUrl": "https://example.com/agent-images/support-agent.png",
    "status": "active",
    "scope": "workspace",
    "userFavorite": true,
    "model": {
      "providerId": "openai",
      "modelId": "gpt-4",
      "temperature": 0.7
    },
    "actions": [],
    "maxStepsPerRun": 10,
    "templateId": "b4e2f1a9c7"
  }
}

Changes

Changed in 2 of the 86 revisions of this API.23

  • 477be28e58581See the full diff
    • ▲

      the request property / became required

      request-property-became-required

  • ad905257873c13See the full diff
    • ▲

      the / request property type changed from object to string, and format from no format to email

      request-property-type-changed

    • ●

      removed the request property //

      request-property-removed

    • ●

      removed the request property //

      request-property-removed

    • ●

      removed the request property //

      request-property-removed