OpenAPI contract

Interface Description

Read the machine-readable OpenAPI contract that describes the Developer OpenAPI.

Endpoint

Field	Value
Method	GET
Path	/openapi/v2/openapi.json
Operation ID	getDeveloperOpenApiContract
Authentication	Bearer OpenAPI key

Parameters

This operation has no path or query parameters.

Request Body

This operation has no request body.

Request Example

curl -X GET "https://openapi.example.com/openapi/v2/openapi.json" \
  -H "Authorization: Bearer <openapi-key>"

Successful Responses

200

Complete OpenAPI 3.1 contract for the Developer OpenAPI.

Field	Required	Type	Description
openapi	Yes	string	OpenAPI Specification version used by this contract.
info	Yes	object	Product, contract version, license, and purpose.
servers	Yes	array<object>	Server base URLs declared by this contract.
security	Yes	array<object>	Default authentication requirements.
tags	Yes	array<object>	Operation groups exposed by this contract.
paths	Yes	object	Documented Developer OpenAPI paths and operations.
components	Yes	object	Reusable schemas and security definitions.

Success Response Example

{
  "openapi": "3.1.0",
  "info": {
    "title": "Focowiki Developer OpenAPI",
    "version": "0.7.47"
  },
  "servers": [
    {
      "url": "https://openapi.example.com"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Knowledge Bases"
    }
  ],
  "paths": {
    "/openapi/v2/knowledge-bases": {
      "get": {
        "operationId": "listKnowledgeBases",
        "summary": "List knowledge bases"
      },
      "post": {
        "operationId": "createKnowledgeBase",
        "summary": "Create a knowledge base"
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {}
  }
}

Error Codes

The table below lists every error response documented for this operation.

HTTP Status	Error Code	Explanation
401	UNAUTHORIZED	The Bearer API key is missing, malformed, unknown, revoked, or deleted.
429	RATE_LIMITED	The request exceeded the configured rate limits.
500	INTERNAL_ERROR	The API encountered an internal error.
503	DATABASE_REPOSITORY_UNAVAILABLE	The data required by this operation is temporarily unavailable.

Next Steps

• List knowledge bases