OpenVibe.AI API
Generated at from
openvibe-contracts v0.53.0 and
openvibe-sdk v0.11.0.
Server https://ai.openvibe.network. 37 routes performing 5 capabilities. OpenAPI 3.1 document.
GET /api/v1/audit
Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.
- Capabilities
- ai.usage.read
- Visibility
- internal
- Response
application/jsonai.usage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.usage.read</strong> (internal): Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.</p>GET /api/v1/cache
Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.
- Capabilities
- ai.usage.read
- Visibility
- internal
- Response
application/jsonai.usage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.usage.read</strong> (internal): Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.</p>DELETE /api/v1/cache
Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.
- Capabilities
- ai.provider.manage
- Visibility
- internal
- Input
- ai.provider-manage-request@1
- Response
application/jsonai.provider-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.provider.manage</strong> (internal): Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.</p>POST /api/v1/chat
Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them.
- Capabilities
- ai.run.create
- Visibility
- first-party
- Request body
application/jsonai.run-create-request@1- Response
application/jsonai.run-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.run.create</strong> (first-party): Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them. A token's <code>ns</code> claim limits which workflow namespaces it may run (live.*, wiki.*, ...). Quotas are checked before any provider call.</p>POST /api/v1/classify
Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them.
- Capabilities
- ai.run.create
- Visibility
- first-party
- Request body
application/jsonai.run-create-request@1- Response
application/jsonai.run-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.run.create</strong> (first-party): Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them. A token's <code>ns</code> claim limits which workflow namespaces it may run (live.*, wiki.*, ...). Quotas are checked before any provider call.</p>POST /api/v1/embed
Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them.
- Capabilities
- ai.run.create
- Visibility
- first-party
- Request body
application/jsonai.run-create-request@1- Response
application/jsonai.run-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.run.create</strong> (first-party): Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them. A token's <code>ns</code> claim limits which workflow namespaces it may run (live.*, wiki.*, ...). Quotas are checked before any provider call.</p>POST /api/v1/enrich
Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them.
- Capabilities
- ai.run.create
- Visibility
- first-party
- Request body
application/jsonai.run-create-request@1- Response
application/jsonai.run-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.run.create</strong> (first-party): Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them. A token's <code>ns</code> claim limits which workflow namespaces it may run (live.*, wiki.*, ...). Quotas are checked before any provider call.</p>POST /api/v1/extract
Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them.
- Capabilities
- ai.run.create
- Visibility
- first-party
- Request body
application/jsonai.run-create-request@1- Response
application/jsonai.run-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.run.create</strong> (first-party): Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them. A token's <code>ns</code> claim limits which workflow namespaces it may run (live.*, wiki.*, ...). Quotas are checked before any provider call.</p>POST /api/v1/generate
Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them.
- Capabilities
- ai.run.create
- Visibility
- first-party
- Request body
application/jsonai.run-create-request@1- Response
application/jsonai.run-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.run.create</strong> (first-party): Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them. A token's <code>ns</code> claim limits which workflow namespaces it may run (live.*, wiki.*, ...). Quotas are checked before any provider call.</p>GET /api/v1/models
Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.
- Capabilities
- ai.usage.read
- Visibility
- internal
- Response
application/jsonai.usage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.usage.read</strong> (internal): Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.</p>POST /api/v1/models
Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.
- Capabilities
- ai.provider.manage
- Visibility
- internal
- Request body
application/jsonai.provider-manage-request@1- Response
application/jsonai.provider-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.provider.manage</strong> (internal): Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.</p>PATCH /api/v1/models/{provider}/{model}
Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.
- Capabilities
- ai.provider.manage
- Visibility
- internal
- Parameters
provider(path, required)model(path, required)
- Request body
application/jsonai.provider-manage-request@1- Response
application/jsonai.provider-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.provider.manage</strong> (internal): Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.</p>GET /api/v1/providers
Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.
- Capabilities
- ai.usage.read
- Visibility
- internal
- Response
application/jsonai.usage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.usage.read</strong> (internal): Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.</p>POST /api/v1/providers
Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.
- Capabilities
- ai.provider.manage
- Visibility
- internal
- Request body
application/jsonai.provider-manage-request@1- Response
application/jsonai.provider-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.provider.manage</strong> (internal): Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.</p>PATCH /api/v1/providers/{key}
Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.
- Capabilities
- ai.provider.manage
- Visibility
- internal
- Parameters
key(path, required)
- Request body
application/jsonai.provider-manage-request@1- Response
application/jsonai.provider-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.provider.manage</strong> (internal): Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.</p>POST /api/v1/providers/{key}/disable
Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.
- Capabilities
- ai.provider.manage
- Visibility
- internal
- Parameters
key(path, required)
- Request body
application/jsonai.provider-manage-request@1- Response
application/jsonai.provider-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.provider.manage</strong> (internal): Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.</p>POST /api/v1/providers/{key}/enable
Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.
- Capabilities
- ai.provider.manage
- Visibility
- internal
- Parameters
key(path, required)
- Request body
application/jsonai.provider-manage-request@1- Response
application/jsonai.provider-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.provider.manage</strong> (internal): Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.</p>POST /api/v1/providers/{key}/reset
Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.
- Capabilities
- ai.provider.manage
- Visibility
- internal
- Parameters
key(path, required)
- Request body
application/jsonai.provider-manage-request@1- Response
application/jsonai.provider-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.provider.manage</strong> (internal): Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.</p>GET /api/v1/quotas
Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.
- Capabilities
- ai.usage.read
- Visibility
- internal
- Response
application/jsonai.usage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.usage.read</strong> (internal): Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.</p>POST /api/v1/quotas
Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.
- Capabilities
- ai.provider.manage
- Visibility
- internal
- Request body
application/jsonai.provider-manage-request@1- Response
application/jsonai.provider-manage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.provider.manage</strong> (internal): Register, update, enable and disable providers and models (secrets only as env references, never values), reset circuit breakers, set quotas and purge the cache.</p>GET /api/v1/requests
Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.
- Capabilities
- ai.usage.read
- Visibility
- internal
- Response
application/jsonai.usage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.usage.read</strong> (internal): Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.</p>POST /api/v1/routes/{key}/versions
Create new versions of prompt templates, workflow definitions and routing profiles, and change their lifecycle status (draft, active, deprecated, archived; routes active/disabled).
- Capabilities
- ai.workflow.manage
- Visibility
- internal
- Parameters
key(path, required)
- Request body
application/jsonai.definition-version-request@1- Response
application/jsonai.definition-version-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.workflow.manage</strong> (internal): Create new versions of prompt templates, workflow definitions and routing profiles, and change their lifecycle status (draft, active, deprecated, archived; routes active/disabled). Every change is audited; edits never overwrite a version.</p>POST /api/v1/routes/{key}/versions/{version}/status
Create new versions of prompt templates, workflow definitions and routing profiles, and change their lifecycle status (draft, active, deprecated, archived; routes active/disabled).
- Capabilities
- ai.workflow.manage
- Visibility
- internal
- Parameters
key(path, required)version(path, required)
- Request body
application/jsonai.definition-version-request@1- Response
application/jsonai.definition-version-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.workflow.manage</strong> (internal): Create new versions of prompt templates, workflow definitions and routing profiles, and change their lifecycle status (draft, active, deprecated, archived; routes active/disabled). Every change is audited; edits never overwrite a version.</p>GET /api/v1/runs
Read the caller's own runs, their citations and request-log metadata (hashes, tokens, latency; never raw prompts).
- Capabilities
- ai.run.read
- Visibility
- first-party
- Response
application/jsonai.run-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.run.read</strong> (first-party): Read the caller's own runs, their citations and request-log metadata (hashes, tokens, latency; never raw prompts).</p>POST /api/v1/runs
Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them.
- Capabilities
- ai.run.create
- Visibility
- first-party
- Request body
application/jsonai.run-create-request@1- Response
application/jsonai.run-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.run.create</strong> (first-party): Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them. A token's <code>ns</code> claim limits which workflow namespaces it may run (live.*, wiki.*, ...). Quotas are checked before any provider call.</p>GET /api/v1/runs/{id}
Read the caller's own runs, their citations and request-log metadata (hashes, tokens, latency; never raw prompts).
- Capabilities
- ai.run.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonai.run-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.run.read</strong> (first-party): Read the caller's own runs, their citations and request-log metadata (hashes, tokens, latency; never raw prompts).</p>POST /api/v1/runs/{id}/cancel
Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them.
- Capabilities
- ai.run.create
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonai.run-create-request@1- Response
application/jsonai.run-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.run.create</strong> (first-party): Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them. A token's <code>ns</code> claim limits which workflow namespaces it may run (live.*, wiki.*, ...). Quotas are checked before any provider call.</p>GET /api/v1/runs/{id}/citations
Read the caller's own runs, their citations and request-log metadata (hashes, tokens, latency; never raw prompts).
- Capabilities
- ai.run.read
- Visibility
- first-party
- Parameters
id(path, required)
- Response
application/jsonai.run-read-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.run.read</strong> (first-party): Read the caller's own runs, their citations and request-log metadata (hashes, tokens, latency; never raw prompts).</p>POST /api/v1/runs/{id}/citations
Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them.
- Capabilities
- ai.run.create
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonai.run-create-request@1- Response
application/jsonai.run-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.run.create</strong> (first-party): Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them. A token's <code>ns</code> claim limits which workflow namespaces it may run (live.*, wiki.*, ...). Quotas are checked before any provider call.</p>POST /api/v1/runs/{id}/retry
Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them.
- Capabilities
- ai.run.create
- Visibility
- first-party
- Parameters
id(path, required)
- Request body
application/jsonai.run-create-request@1- Response
application/jsonai.run-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.run.create</strong> (first-party): Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them. A token's <code>ns</code> claim limits which workflow namespaces it may run (live.*, wiki.*, ...). Quotas are checked before any provider call.</p>GET /api/v1/status
Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.
- Capabilities
- ai.usage.read
- Visibility
- internal
- Response
application/jsonai.usage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.usage.read</strong> (internal): Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.</p>POST /api/v1/summarize
Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them.
- Capabilities
- ai.run.create
- Visibility
- first-party
- Request body
application/jsonai.run-create-request@1- Response
application/jsonai.run-create-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.run.create</strong> (first-party): Create workflow runs (POST /api/v1/runs and the direct chat/generate/summarize/classify/extract/enrich/embed operations), cancel or retry the caller's own runs and attach citations to them. A token's <code>ns</code> claim limits which workflow namespaces it may run (live.*, wiki.*, ...). Quotas are checked before any provider call.</p>POST /api/v1/templates/{key}/versions
Create new versions of prompt templates, workflow definitions and routing profiles, and change their lifecycle status (draft, active, deprecated, archived; routes active/disabled).
- Capabilities
- ai.workflow.manage
- Visibility
- internal
- Parameters
key(path, required)
- Request body
application/jsonai.definition-version-request@1- Response
application/jsonai.definition-version-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.workflow.manage</strong> (internal): Create new versions of prompt templates, workflow definitions and routing profiles, and change their lifecycle status (draft, active, deprecated, archived; routes active/disabled). Every change is audited; edits never overwrite a version.</p>POST /api/v1/templates/{key}/versions/{version}/status
Create new versions of prompt templates, workflow definitions and routing profiles, and change their lifecycle status (draft, active, deprecated, archived; routes active/disabled).
- Capabilities
- ai.workflow.manage
- Visibility
- internal
- Parameters
key(path, required)version(path, required)
- Request body
application/jsonai.definition-version-request@1- Response
application/jsonai.definition-version-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.workflow.manage</strong> (internal): Create new versions of prompt templates, workflow definitions and routing profiles, and change their lifecycle status (draft, active, deprecated, archived; routes active/disabled). Every change is audited; edits never overwrite a version.</p>GET /api/v1/usage
Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.
- Capabilities
- ai.usage.read
- Visibility
- internal
- Response
application/jsonai.usage-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.usage.read</strong> (internal): Read usage, quota windows, request logs, the audit log, cache statistics, the admin summary and any caller's runs.</p>POST /api/v1/workflows/{key}/versions
Create new versions of prompt templates, workflow definitions and routing profiles, and change their lifecycle status (draft, active, deprecated, archived; routes active/disabled).
- Capabilities
- ai.workflow.manage
- Visibility
- internal
- Parameters
key(path, required)
- Request body
application/jsonai.definition-version-request@1- Response
application/jsonai.definition-version-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>ai.workflow.manage</strong> (internal): Create new versions of prompt templates, workflow definitions and routing profiles, and change their lifecycle status (draft, active, deprecated, archived; routes active/disabled). Every change is audited; edits never overwrite a version.</p>POST /api/v1/workflows/{key}/versions/{version}/status
Create new versions of prompt templates, workflow definitions and routing profiles, and change their lifecycle status (draft, active, deprecated, archived; routes active/disabled).
- Capabilities
- ai.workflow.manage
- Visibility
- internal
- Parameters
key(path, required)version(path, required)
- Request body
application/jsonai.definition-version-request@1- Response
application/jsonai.definition-version-result@1- Errors
- errors.problem@1 (application/problem+json)