Skip to content
API docs
Sign inOpen app

Forms

Brief an AI coding agent

POST/v1/forms/{formId}/agent-handoff

Write a one-time brief in markdown that an AI coding agent follows to embed, publish and check this form on its brand's website. By default it creates a new workspace API key for the brief. Revoke that key when the agent is done.

Path parameters

  • formIdstringrequired

Body

JSON, with Content-Type: application/json.

  • notesstring

    Where and how to place the form, for the agent. It goes into the brief word for word.

    max 5000 chars

  • includeSecretsboolean

    Defaults to true. When true, a new API key is created and put in the brief, along with the signing secrets of the webhooks that get this form's responses. When false, no key is created and the brief has the placeholders YOUR_API_KEY and YOUR_WEBHOOK_SECRET instead.

Response

  • promptstringrequired

    The brief, in markdown.

  • apiKeyIdstring or nullrequired

    The API key created for the brief. Null when includeSecrets is false.

  • apiKeyNamestring or nullrequired

    The name of that key. Null when includeSecrets is false.

Errors answer with a status and the error shape.