Create Superagent

Changed on

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Creates a Superagent that you own. Send it messages through Create Superagent conversation, using the id this returns as agent_id.

The agent is created in your access token's workspace, or in your default workspace when you use a personal API key. The request waits while the agent's workspace is set up, which takes a few seconds. If setup fails, the agent is removed and you can retry. A retry after a lost response creates a second agent. A personal access token limited to selected apps can't call the new agent afterwards, because the agent isn't on its list.

This endpoint is limited to 5 requests per minute, shared with Create app.

<Note>This endpoint accepts a personal API key or personal access token belonging to a workspace editor. A read-only key is refused, and workspace API keys are not accepted.</Note>

<Warning>The response includes fields beyond the ones documented here. Don't rely on undocumented response fields, as they can change at any time. Send only the fields documented here. Other request fields are not supported and their behavior can change.</Warning>

post/api/agents

Request

  • Base URL: https://app.base44.com
  • URL: https://app.base44.com/api/agents
  • Auth: HTTP bearer

Request body

namestring required

Name of the agent. Leading and trailing spaces are removed.

descriptionstring nullable

Short description of what the agent is for.

logo_urlstring nullable

URL of the agent's logo image.

Example request

{
  "name": "Sales assistant",
  "description": "Answers questions about our weekly sales.",
  "logo_url": "https://cdn.acme.com/sales-assistant.png"
}

Response

The new agent.

idstring required

ID of the agent. Use it as agent_id in the other Superagent endpoints, such as Create Superagent conversation.

namestring required

Name of the agent.

descriptionstring nullable

Description of the agent, or null if none was set.

logo_urlstring nullable

URL of the agent's logo, or null if none was set.

Example response

{
  "id": "6820f3a4e7b91d003c45a1f2",
  "name": "Sales assistant",
  "description": "Answers questions about our weekly sales.",
  "logo_url": "https://cdn.acme.com/sales-assistant.png"
}

Changes