public_api
external

Invoke Capability

post/v1/capabilities/{capability_key}/invoke

Request

  • Base URL: https://api.hydracept.com
  • URL: https://api.hydracept.com/v1/capabilities/{capability_key}/invoke
  • Auth: HTTP bearer

Path parameters

capability_keystring required

Request body

externalRefstring nullable

Opaque caller-owned correlation reference. Never sent to providers. Max 255 characters.

tagsstring[]

Caller-owned flat labels for correlation and future exact-match filtering. At most 32 tags; each tag max 256 characters.

metadataobject

Opaque caller-owned JSON bookkeeping. Never interpreted or sent to providers. Serialized size capped at 16384 UTF-8 bytes.

responseSchemaobject nullable
toolSchemasobject[] nullable
maturityRating'G' | 'PG' | 'PG13' | 'R' | 'NC17'
matureContentTraitsMatureContentTrait[]
maturitySource'explicit_invocation' | 'project_default' | 'workload_derived' | 'legacy_default'
inputobject
inputPayloadRefstring nullable

Verified payload id from POST /v1/payloads. When set, inline input is optional; the server resolves content before admission, estimate, and stream dispatch.

idempotencyKeystring nullable
correlationIdstring nullable
taskKindstring nullable
executionMode'RequestResponse' | 'Stream' | 'DurableJob' | 'ProductionWorkflow'

Response

Successful response

executionIdstring required
idempotencyKeystring nullable
statusstring required
resolvedProviderstring nullable
resolvedModelstring nullable
selectedCandidateIdstring nullable
servedCandidateIdstring nullable
credentialModestring nullable
credentialSourcestring nullable
externalRefstring nullable
tagsstring[]
metadataobject
typedOutputunknown
outputPayloadRefstring nullable
generatedArtifactsstring[]
actualCostnumber
terminationReasonstring nullable
receiptIdstring nullable
errorCodestring nullable
dispatchStatusstring nullable
warningsobject[]

Changes

No recorded changes to this operation across all 1 revision of this API.