integration

Register an agent target (atomic prove-then-persist)

Fires a live round-trip and persists the target ONLY if the probe succeeds; a failed probe persists nothing and returns a categorized error (unreachable / auth_failed / parse_error / no_reply / not_an_endpoint). Static auth (none/bearer/api_key/basic) or oauth_client_credentials, over http or websocket. The response never echoes the config, credential, or reply. The returned model_id is the handle for POST /api/v1/run. List first via GET /api/v1/model — creates are not deduplicated.

post/api/v1/model

Request

  • Base URL: https://api.enokilabs.ai
  • URL: https://api.enokilabs.ai/api/v1/model
  • Auth: none declared

Headers

Authorizationstring nullable

Bearer token with API key

Request body

namestring required

Display name for the target.

environment'prod' | 'staging' | 'dev'
auth_type'none' | 'bearer' | 'api_key' | 'basic' | 'oauth_client_credentials'

bearer='Authorization: Bearer <cred>', api_key='x-api-key: <cred>', basic=HTTP Basic with the credential as 'user:password', oauth_client_credentials=an access token minted from the 'oauth' config below and re-minted before it expires. No enterprise auth.

credentialstring nullable

Required for bearer/api_key/basic, and the OAuth client secret for oauth_client_credentials; omit for none. Stored encrypted, never returned.

Response

Successful Response

model_idstring required

Inventory model id — use directly as model_id in POST /api/v1/run.

connectedtrue required

Always true: the target is persisted only after a successful probe.

Changes

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