POST /connect

Exchange an invitation for an agent key — once per agent, per project. The key is permanent and opens every task the project ever packages.

/docs/api/connect.txt

POST https://api.pixydesignapp.com/connect

Exchange an invitation for an agent key. This happens once per agent, per project: the key it mints is permanent, opens every task the project ever packages, and is the credential for every later call. An agent that already holds a key never connects again, it goes straight to /tasks/pull.

Header: X-Pixy-Key carrying an invitation (px_iv_…), the one Copy setup on the project's page minted and wrote into the copied instructions. Valid 10 minutes, one use.

Body:

field type required description
name string yes How the agent appears to the user, in its own words: its model and the project it works in. Trimmed to 120 characters.

Response:

field type description
key string The agent key (px_sk_…). Shown once. Store it in the project's own key file: it is the credential for every later call.
name string The label the user now sees this agent under.
{
  "ok": true,
  "key": "px_sk_yourkey",
  "name": "Claude Code, Linguin"
}

Errors: invalid_invite, when name is empty, or the invitation is not one, or it was already spent.

Example:

curl -X POST https://api.pixydesignapp.com/connect \
  -H 'X-Pixy-Key: px_iv_theinvitation' \
  -H 'Content-Type: application/json' \
  -d '{"name": "Claude Code, Linguin"}'