Roark · Schema

HttpRequestDefinitionResponse

HTTP request definition

CompanyVoice AITestingEvaluationBenchmarking

Properties

Name Type Description
id string HTTP request definition ID
scope string Scope of the HTTP request definition
description stringnull Description of the HTTP request definition
url string URL for the HTTP request
method string HTTP method: POST, PUT, PATCH, or GET
body stringnull Request body as a string
parsedBody object Parsed body as a JSON object if valid JSON, otherwise the raw string
headers object Request headers as key-value pairs
isConfigManaged boolean Whether this definition is managed by config-as-code. A managed definition is reconciled from your config: PUT returns 409, and changes belong in the config file (or detach it first).
createdAt string Creation timestamp
updatedAt string Last update timestamp
View JSON Schema on GitHub

JSON Schema

roark-http-request-definition-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/roark/json-schema/roark-http-request-definition-response-schema.json",
  "title": "HttpRequestDefinitionResponse",
  "description": "HTTP request definition",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/roark-http-request-definition-api-openapi.yml#/components/schemas/HttpRequestDefinitionResponse",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "HTTP request definition ID"
    },
    "scope": {
      "type": "string",
      "enum": [
        "AGENT_OUTBOUND_DIAL"
      ],
      "description": "Scope of the HTTP request definition"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Description of the HTTP request definition"
    },
    "url": {
      "type": "string",
      "description": "URL for the HTTP request"
    },
    "method": {
      "type": "string",
      "enum": [
        "POST",
        "PUT",
        "PATCH",
        "GET"
      ],
      "description": "HTTP method: POST, PUT, PATCH, or GET"
    },
    "body": {
      "type": [
        "string",
        "null"
      ],
      "description": "Request body as a string"
    },
    "parsedBody": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": {}
        },
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Parsed body as a JSON object if valid JSON, otherwise the raw string"
    },
    "headers": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Request headers as key-value pairs"
    },
    "isConfigManaged": {
      "type": "boolean",
      "description": "Whether this definition is managed by config-as-code. A managed definition is reconciled from your config: PUT returns 409, and changes belong in the config file (or detach it first)."
    },
    "createdAt": {
      "type": "string",
      "description": "Creation timestamp"
    },
    "updatedAt": {
      "type": "string",
      "description": "Last update timestamp"
    }
  },
  "required": [
    "id",
    "scope",
    "description",
    "url",
    "method",
    "body",
    "parsedBody",
    "headers",
    "isConfigManaged",
    "createdAt",
    "updatedAt"
  ]
}

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/roark-http-request-definition-response"
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.