Skip to main content

SuccessResponse_ExternalApiEndpoint

successboolean
Constant value: true
data object
idinteger
pathstring
Example: /search
methodstring
Example: GET
operationIdstring | nullnullable
summarystring | nullnullable
descriptionstring | nullnullable
isEnabledboolean
isPublicboolean

Whether this endpoint is exposed via the cross-organization marketplace (only meaningful when the owning connector is also public).

parameterSchemaobject

JSON-Schema tree describing this endpoint's path/query/header parameters, derived from the imported OpenAPI spec.

requestBodySchemaobject | nullnullable

JSON-Schema for the request body. Null for GET/HEAD or specs with no request body.

responseSchemaobject | nullnullable

JSON-Schema for the primary 2xx response, when declared in the spec.

sampleResponseobject | nullnullable

The most recent successful JSON response body captured by a test call, used as a live preview.

pinnedParams objectnull

Operator-pinned query params always applied upstream (proxy and test calls), overriding any caller-supplied value for the same key.

property name* object
oneOf
string
timeoutinteger | nullnullable

Milliseconds. Falls back to the connector's defaultTimeout when null.

connectorIdinteger
organizationIdinteger
createdAtstring<date-time>
updatedAtstring<date-time>
deletedAtstring,null<date-time>nullable
pricePerMillionDataTokensnumber | nullnullable

The endpoint's current effective-dated price in the owner organization's currency, resolved from external_api_endpoint_prices. Null when never priced.

SuccessResponse_ExternalApiEndpoint
{
  "success": true,
  "data": {
    "id": 0,
    "path": "/search",
    "method": "GET",
    "operationId": "string",
    "summary": "string",
    "description": "string",
    "isEnabled": true,
    "isPublic": true,
    "parameterSchema": {},
    "requestBodySchema": "Unknown Type: object,null",
    "responseSchema": "Unknown Type: object,null",
    "sampleResponse": "Unknown Type: object,null",
    "pinnedParams": "Unknown Type: object,null",
    "timeout": 0,
    "connectorId": 0,
    "organizationId": 0,
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "deletedAt": "2024-07-29T15:51:28.071Z",
    "pricePerMillionDataTokens": 0
  }
}