superdocs-app · Schema

AgentSignupRequest

Body for POST /v1/agents/signup. Every field except terms_accepted is optional.

Artificial IntelligenceDocument EditingREST APIMCPSoftware-as-a-Service

Properties

Name Type Description
terms_accepted boolean Must be true. Accepts the Terms at https://typebar.ai/terms. If you are an agent, confirm with your user first.
agent_name object Optional label for this agent account.
operated_by_email object Optional. Your human operator's email (only used if you later hand off the account).
model_metadata object Optional. Free-form metadata about the agent/model (forensics; capped at 10KB).
altcha object Only required if the proof-of-work challenge is enabled: the base64 solution from GET /v1/agents/challenge.
View JSON Schema on GitHub

JSON Schema

superdocs-app-agent-signup-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/superdocs-app/json-schema/superdocs-app-agent-signup-request-schema.json",
  "title": "AgentSignupRequest",
  "description": "Body for POST /v1/agents/signup. Every field except terms_accepted is optional.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/superdocs-app-agents-api-openapi.yml#/components/schemas/AgentSignupRequest",
  "properties": {
    "terms_accepted": {
      "type": "boolean",
      "title": "Terms Accepted",
      "description": "Must be true. Accepts the Terms at https://typebar.ai/terms. If you are an agent, confirm with your user first.",
      "default": false
    },
    "agent_name": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 64
        },
        {
          "type": "null"
        }
      ],
      "title": "Agent Name",
      "description": "Optional label for this agent account."
    },
    "operated_by_email": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 255
        },
        {
          "type": "null"
        }
      ],
      "title": "Operated By Email",
      "description": "Optional. Your human operator's email (only used if you later hand off the account)."
    },
    "model_metadata": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Model Metadata",
      "description": "Optional. Free-form metadata about the agent/model (forensics; capped at 10KB)."
    },
    "altcha": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Altcha",
      "description": "Only required if the proof-of-work challenge is enabled: the base64 solution from GET /v1/agents/challenge."
    }
  },
  "type": "object"
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/superdocs-app-agent-signup-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.