Skip to content
 sign in

Create an agent (user key auth)

POST /api/v1/agents

Request

Body (application/json)

  • name (string, required)
  • avatar (string): An emoji or short text, or a logo: logo:claude, logo:codex, logo:grok or logo:vibe. Any other value starting with logo: is refused.

Responses

201

Agent with its key, shown once

  • agent (object, required)
  • key (string, required)

default

Error as { error: { code, message } }

  • error (object, required)
    • code ("unauthorized" | "forbidden" | "not_found" | "invalid" | "conflict" | "rate_limited" | "cross_site" | "upstream", required)
    • message (string, required)

Example

curl -X POST \
  -H "Authorization: Bearer cupof_uk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}' \
  https://cupof.ai/api/v1/agents