Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: DialogBrain v2 API Gateway Artifacts API
description: Clean refactored API gateway with minimal vertical slice
version: 0.1.0
tags:
- name: Artifacts
paths:
/api/artifacts/{artifact_id}/view-token:
post:
tags:
- Artifacts
summary: Create View Token
description: 'Short-lived token letting the in-app viewer iframe load a private artifact.
Cross-workspace requests get 404 (not 403) — consistent with the serve
route''s no-existence-oracle rule: artifact ids must not be probeable.
NOTE: artifacts live on the MAIN engine (async_session_maker) — the same
one the serve route and the artifacts.* tools use — deliberately not
get_workspace_session, which can route to a per-workspace engine that has
no artifacts tables.'
operationId: create_view_token_api_artifacts__artifact_id__view_token_post
parameters:
- name: artifact_id
in: path
required: true
schema:
type: integer
title: Artifact Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/artifacts:
get:
tags:
- Artifacts
summary: List Artifacts
operationId: list_artifacts_api_artifacts_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/api/artifacts/by-slug/{slug}:
get:
tags:
- Artifacts
summary: Locate Artifact
description: 'Which workspace an artifact lives in, for a link opened from another one.
An artifact''s link carries only its slug, and the viewer lists the CURRENT
workspace, so a link handed from one workspace to a member who is sitting
in another found nothing and said "failed to load". This answers where it
is, for a workspace the caller is a member of, so the viewer can say so and
offer the switch. Membership is the whole gate: an artifact in a workspace
the caller does not belong to is 404, the same answer as no artifact at all,
so the slug cannot be used to probe.'
operationId: locate_artifact_api_artifacts_by_slug__slug__get
parameters:
- name: slug
in: path
required: true
schema:
type: string
title: Slug
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/artifacts/report:
post:
tags:
- Artifacts
summary: Create Report
description: 'The analytics ''Build report'' action: compose saved dashboard cards into
a private artifact (same path as artifacts.create(analytics_card_ids=...)).'
operationId: create_report_api_artifacts_report_post
requestBody:
content:
application/json:
schema:
additionalProperties: true
type: object
title: Payload
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/artifacts/{artifact_id}/access:
post:
tags:
- Artifacts
summary: Set Artifact Access
operationId: set_artifact_access_api_artifacts__artifact_id__access_post
parameters:
- name: artifact_id
in: path
required: true
schema:
type: integer
title: Artifact Id
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: true
title: Payload
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/artifacts/{artifact_id}:
delete:
tags:
- Artifacts
summary: Delete Artifact
operationId: delete_artifact_api_artifacts__artifact_id__delete
parameters:
- name: artifact_id
in: path
required: true
schema:
type: integer
title: Artifact Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError