openapi: 3.0.1 info: title: MetaLoom // Loom REST API description: |- REST API of the MetaLoom Loom server - the asset library, its metadata model and the pipeline engine that drives the Cortex processing nodes. All routes are mounted under `/api/v1`. Requests are authenticated with a JWT which is obtained from `POST /api/v1/login` and is sent either as an `Authorization: Bearer ` header or as the `__Host-loom_token` cookie the login route sets. This document is generated from the endpoint registry of the server - see the REST API documentation on https://metaloom.io/docs/loom/rest-api/. version: "1.0" servers: - url: http://localhost:8092 description: Loom server security: - bearerAuth: [] - cookieAuth: [] tags: - name: annotations description: "Annotations on assets, plus their reactions and tasks" - name: assets description: "Assets and their sub-resources: tags, tasks, reactions, detections,\ \ transcripts, binaries and components" - name: attachments description: Binary file attachments (multipart upload and download) - name: auth description: "OAuth2 (BFF) login, callback and logout" - name: binaries description: Standalone binaries - name: blacklists description: Blacklisted content - name: chat-sessions description: Chat sessions - publishable snapshots of a chat's working state - name: chats description: AI agent chats and the SSE run stream - name: clusters description: Face/embedding clusters - name: collections description: Asset collections - name: comments description: Comments and their reactions - name: embeddings description: Vector embeddings and their attachments - name: graphql description: GraphQL query endpoint - name: groups description: Groups of the RBAC model - name: health description: Liveness and readiness information - name: info description: API information and this OpenAPI document - name: libraries description: Asset libraries - name: login description: Username and password login - name: me description: The currently authenticated user - name: memory description: "Agent memory - scopes, notes and entries" - name: memory-deny-rules description: Administration of the agent memory denylist - name: persons description: Persons known to the face recognition model - name: pipeline description: Pipeline node descriptors and content types - name: pipelines description: "Pipeline definitions, versions, runs and the event stream" - name: pools description: Asset pools - name: processors description: Registered Cortex processor nodes - name: reactions description: Reactions - name: roles description: Roles of the RBAC model - name: sessions description: Files of a chat's coding sandbox session - name: skills description: "Agent skills, the published skill library and installs" - name: spaces description: Spaces - name: tags description: Tags - name: tasks description: Tasks and their reactions and comments - name: tokens description: API tokens for programmatic access - name: users description: Users of the RBAC model paths: /api/v1: description: Load REST API info get: tags: - info summary: Load REST API info description: Load REST API info operationId: get responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/annotations: description: Create new annotation get: tags: - annotations summary: Load a paged list of annotations description: Load a paged list of annotations operationId: getAnnotations parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The annotation list response content: application/json: example: data: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef type: FEEDBACK title: The annotation title area: from: 12 to: 42 width: 480 height: 200 startX: 120 startY: 240 description: The annotation description tasks: [] comments: [] tags: [] assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef type: FEEDBACK title: The annotation title area: from: 12 to: 42 width: 480 height: 200 startX: 120 startY: 240 description: The annotation description tasks: [] comments: [] tags: [] assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - annotations summary: Create new annotation description: Create new annotation operationId: postAnnotations requestBody: content: application/json: example: type: FEEDBACK title: The annotation title area: from: 12 to: 42 width: 480 height: 200 startX: 120 startY: 240 description: The annotation description meta: abc: cdef assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 responses: "200": description: The annotation response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef type: FEEDBACK title: The annotation title area: from: 12 to: 42 width: 480 height: 200 startX: 120 startY: 240 description: The annotation description tasks: [] comments: [] tags: [] assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/annotations/{annotationUuid}/reactions: description: Create a new reaction for an annotation get: tags: - annotations summary: Load a paged list of reactions on the annotation description: Load a paged list of reactions on the annotation operationId: getAnnotationsByAnnotationUuidReactions responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - annotations summary: Create a new reaction for an annotation description: Create a new reaction for an annotation operationId: postAnnotationsByAnnotationUuidReactions responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: annotationUuid in: path description: UUID of the referenced annotation required: true schema: type: string format: uuid /api/v1/annotations/{annotationUuid}/reactions/{reactionUuid}: description: Delete a reaction for an annotation get: tags: - annotations summary: Load the reaction for the annotation description: Load the reaction for the annotation operationId: getAnnotationsByAnnotationUuidReactionsByReactionUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - annotations summary: Update the reaction on the annotation description: Update the reaction on the annotation operationId: postAnnotationsByAnnotationUuidReactionsByReactionUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - annotations summary: Delete a reaction for an annotation description: Delete a reaction for an annotation operationId: deleteAnnotationsByAnnotationUuidReactionsByReactionUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: annotationUuid in: path description: UUID of the referenced annotation required: true schema: type: string format: uuid - name: reactionUuid in: path description: UUID of the referenced reaction required: true schema: type: string format: uuid /api/v1/annotations/{annotationUuid}/tasks: description: List the tasks assigned to the annotation get: tags: - annotations summary: List the tasks assigned to the annotation description: List the tasks assigned to the annotation operationId: getAnnotationsByAnnotationUuidTasks responses: "200": description: The task list response content: application/json: example: data: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} meta: abc: cdef title: The title priority: MEDIUM taskStatus: PENDING dueDate: 2026-08-01T12:00:00Z comments: [] _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: annotationUuid in: path description: UUID of the referenced annotation required: true schema: type: string format: uuid /api/v1/annotations/{annotationUuid}/tasks/{taskUuid}: description: Assign an existing task to the annotation post: tags: - annotations summary: Assign an existing task to the annotation description: Assign an existing task to the annotation operationId: postAnnotationsByAnnotationUuidTasksByTaskUuid responses: "200": description: The task response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} meta: abc: cdef title: The title priority: MEDIUM taskStatus: PENDING dueDate: 2026-08-01T12:00:00Z comments: [] "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - annotations summary: Unassign a task from the annotation description: Unassign a task from the annotation operationId: deleteAnnotationsByAnnotationUuidTasksByTaskUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: annotationUuid in: path description: UUID of the referenced annotation required: true schema: type: string format: uuid - name: taskUuid in: path description: UUID of the referenced task required: true schema: type: string format: uuid /api/v1/annotations/{uuid}: description: Update a annotation get: tags: - annotations summary: Load a annotation description: Load a annotation operationId: getAnnotationsByUuid responses: "200": description: The annotation response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef type: FEEDBACK title: The annotation title area: from: 12 to: 42 width: 480 height: 200 startX: 120 startY: 240 description: The annotation description tasks: [] comments: [] tags: [] assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - annotations summary: Update a annotation description: Update a annotation operationId: postAnnotationsByUuid requestBody: content: application/json: example: meta: abc: cdef type: FEEDBACK title: The annotation title area: from: 12 to: 42 width: 480 height: 200 startX: 120 startY: 240 description: The annotation description assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 responses: "200": description: The annotation response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef type: FEEDBACK title: The annotation title area: from: 12 to: 42 width: 480 height: 200 startX: 120 startY: 240 description: The annotation description tasks: [] comments: [] tags: [] assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - annotations summary: Delete a annotation description: Delete a annotation operationId: deleteAnnotationsByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/assets: description: Create a new asset get: tags: - assets summary: List assets description: List assets operationId: getAssets responses: "200": description: The asset list response content: application/json: example: data: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef geo: lon: 32.56 lat: 52.156 tags: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: red annotations: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue collections: [] embeddings: [] file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z hashes: sha512: 0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123 sha256: f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2 md5: d8e8fca2dc0f896fd7cb4cb0031ba249 geoComponents: [] imageComponents: - dominantColor: "#FFFF00" videoComponents: - width: 4000 height: 2250 duration: 20000 audioComponents: - channels: 2 encoding: mp3 samplingRate: 48000 bpm: 120 documentComponents: [] locations: - status: {} poolUuid: 86abc160-4da2-4951-a91f-da0c33fbc634 mimeType: video/mp4 state: PRESENT license: CC-BY-4.0 filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef geo: lon: 32.56 lat: 52.156 tags: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: red annotations: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue collections: [] embeddings: [] file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z hashes: sha512: 0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123 sha256: f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2 md5: d8e8fca2dc0f896fd7cb4cb0031ba249 geoComponents: [] imageComponents: - dominantColor: "#FFFF00" videoComponents: - width: 4000 height: 2250 duration: 20000 audioComponents: - channels: 2 encoding: mp3 samplingRate: 48000 bpm: 120 documentComponents: [] locations: - status: {} poolUuid: 86abc160-4da2-4951-a91f-da0c33fbc634 mimeType: video/mp4 state: PRESENT license: CC-BY-4.0 filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Create a new asset description: Create a new asset operationId: postAssets requestBody: content: application/json: example: meta: abc: cdef geo: lon: 32.56 lat: 52.156 timeline: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z image: dominantColor: "#FFFF00" embeddings: [] responses: "200": description: The asset response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef geo: lon: 32.56 lat: 52.156 tags: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: red annotations: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue collections: [] embeddings: [] file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z hashes: sha512: 0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123 sha256: f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2 md5: d8e8fca2dc0f896fd7cb4cb0031ba249 geoComponents: [] imageComponents: - dominantColor: "#FFFF00" videoComponents: - width: 4000 height: 2250 duration: 20000 audioComponents: - channels: 2 encoding: mp3 samplingRate: 48000 bpm: 120 documentComponents: [] locations: - status: {} poolUuid: 86abc160-4da2-4951-a91f-da0c33fbc634 mimeType: video/mp4 state: PRESENT license: CC-BY-4.0 filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/assets/{assetUuid}/components: description: List all components for an asset get: tags: - assets summary: List all components for an asset description: List all components for an asset operationId: getAssetsByAssetUuidComponents responses: "200": description: The asset component list response content: application/json: example: data: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} type: IMAGE source: exif image: dominantColor: "#FF0000" width: 1920 height: 1080 - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} type: GEO source: exif geo: lon: 2.3522 lat: 48.8566 alias: Paris - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} type: JSON source: yolo-detector json: schemaType: yolo-detection data: detections: 3 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Create a new component for an asset description: Create a new component for an asset operationId: postAssetsByAssetUuidComponents requestBody: content: application/json: example: type: IMAGE source: exif image: dominantColor: "#FF0000" width: 1920 height: 1080 responses: "200": description: The asset component response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} type: IMAGE source: exif image: dominantColor: "#FF0000" width: 1920 height: 1080 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: assetUuid in: path description: UUID of the referenced asset required: true schema: type: string format: uuid /api/v1/assets/{assetUuid}/components/{compUuid}: description: Load a component by UUID get: tags: - assets summary: Load a component by UUID description: Load a component by UUID operationId: getAssetsByAssetUuidComponentsByCompUuid responses: "200": description: The asset component response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} type: IMAGE source: exif image: dominantColor: "#FF0000" width: 1920 height: 1080 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Update a component description: Update a component operationId: postAssetsByAssetUuidComponentsByCompUuid requestBody: content: application/json: example: type: IMAGE source: exif-updated image: dominantColor: "#00FF00" width: 3840 height: 2160 responses: "200": description: The asset component response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} type: IMAGE source: exif image: dominantColor: "#FF0000" width: 1920 height: 1080 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - assets summary: Delete a component description: Delete a component operationId: deleteAssetsByAssetUuidComponentsByCompUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: assetUuid in: path description: UUID of the referenced asset required: true schema: type: string format: uuid - name: compUuid in: path description: UUID of the referenced comp required: true schema: type: string format: uuid /api/v1/assets/{uuid}: description: Load an asset by UUID get: tags: - assets summary: Load an asset by UUID description: Load an asset by UUID operationId: getAssetsByUuid responses: "200": description: The asset response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef geo: lon: 32.56 lat: 52.156 tags: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: red annotations: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue collections: [] embeddings: [] file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z hashes: sha512: 0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123 sha256: f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2 md5: d8e8fca2dc0f896fd7cb4cb0031ba249 geoComponents: [] imageComponents: - dominantColor: "#FFFF00" videoComponents: - width: 4000 height: 2250 duration: 20000 audioComponents: - channels: 2 encoding: mp3 samplingRate: 48000 bpm: 120 documentComponents: [] locations: - status: {} poolUuid: 86abc160-4da2-4951-a91f-da0c33fbc634 mimeType: video/mp4 state: PRESENT license: CC-BY-4.0 filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" put: tags: - assets summary: Replace an asset by UUID. All replaceable fields must be present in the request body. description: Replace an asset by UUID. All replaceable fields must be present in the request body. operationId: putAssetsByUuid requestBody: content: application/json: example: meta: abc: cdef timeline: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z image: dominantColor: "#FFFF00" geo: lon: 32.56 lat: 52.156 responses: "200": description: The asset response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef geo: lon: 32.56 lat: 52.156 tags: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: red annotations: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue collections: [] embeddings: [] file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z hashes: sha512: 0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123 sha256: f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2 md5: d8e8fca2dc0f896fd7cb4cb0031ba249 geoComponents: [] imageComponents: - dominantColor: "#FFFF00" videoComponents: - width: 4000 height: 2250 duration: 20000 audioComponents: - channels: 2 encoding: mp3 samplingRate: 48000 bpm: 120 documentComponents: [] locations: - status: {} poolUuid: 86abc160-4da2-4951-a91f-da0c33fbc634 mimeType: video/mp4 state: PRESENT license: CC-BY-4.0 filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Update an asset by UUID description: Update an asset by UUID operationId: postAssetsByUuid requestBody: content: application/json: example: meta: abc: cdef timeline: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z image: dominantColor: "#FFFF00" geo: lon: 32.56 lat: 52.156 responses: "200": description: The asset response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef geo: lon: 32.56 lat: 52.156 tags: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: red annotations: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue collections: [] embeddings: [] file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z hashes: sha512: 0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123 sha256: f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2 md5: d8e8fca2dc0f896fd7cb4cb0031ba249 geoComponents: [] imageComponents: - dominantColor: "#FFFF00" videoComponents: - width: 4000 height: 2250 duration: 20000 audioComponents: - channels: 2 encoding: mp3 samplingRate: 48000 bpm: 120 documentComponents: [] locations: - status: {} poolUuid: 86abc160-4da2-4951-a91f-da0c33fbc634 mimeType: video/mp4 state: PRESENT license: CC-BY-4.0 filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - assets summary: Delete an asset by UUID description: Delete an asset by UUID operationId: deleteAssetsByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" patch: tags: - assets summary: Partially update an asset by UUID. Only the fields present in the request body are modified. description: Partially update an asset by UUID. Only the fields present in the request body are modified. operationId: patchAssetsByUuid requestBody: content: application/json: example: meta: abc: cdef timeline: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z image: dominantColor: "#FFFF00" geo: lon: 32.56 lat: 52.156 responses: "200": description: The asset response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef geo: lon: 32.56 lat: 52.156 tags: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: red annotations: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue collections: [] embeddings: [] file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z hashes: sha512: 0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123 sha256: f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2 md5: d8e8fca2dc0f896fd7cb4cb0031ba249 geoComponents: [] imageComponents: - dominantColor: "#FFFF00" videoComponents: - width: 4000 height: 2250 duration: 20000 audioComponents: - channels: 2 encoding: mp3 samplingRate: 48000 bpm: 120 documentComponents: [] locations: - status: {} poolUuid: 86abc160-4da2-4951-a91f-da0c33fbc634 mimeType: video/mp4 state: PRESENT license: CC-BY-4.0 filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/assets/{uuid}/binary: description: Create a binary for the asset get: tags: - assets summary: Load the binary for the asset description: Load the binary for the asset operationId: getAssetsByUuidBinary responses: "200": description: The location response content: application/json: example: status: {} filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Create a binary for the asset description: Create a binary for the asset operationId: postAssetsByUuidBinary requestBody: content: application/json: example: {} responses: "200": description: The location response content: application/json: example: status: {} filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - assets summary: Delete the binary for the asset description: Delete the binary for the asset operationId: deleteAssetsByUuidBinary responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/assets/{uuid}/binary/data: description: Upload raw file bytes into the binary for an existing asset. Expects a multipart request with one file part; a 'libraryUuid' form field is required only when the asset has no binary yet. get: tags: - assets summary: Download the raw binary bytes for the asset. description: Download the raw binary bytes for the asset. operationId: getAssetsByUuidBinaryData responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Upload raw file bytes into the binary for an existing asset. Expects a multipart request with one file part; a 'libraryUuid' form field is required only when the asset has no binary yet. description: Upload raw file bytes into the binary for an existing asset. Expects a multipart request with one file part; a 'libraryUuid' form field is required only when the asset has no binary yet. operationId: postAssetsByUuidBinaryData responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/assets/{uuid}/comments: description: Create a new comment on an asset get: tags: - assets summary: List the comments on an asset description: List the comments on an asset operationId: getAssetsByUuidComments responses: "200": description: The comment list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: The Title text: The comment text - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: The Title text: The comment text _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Create a new comment on an asset description: Create a new comment on an asset operationId: postAssetsByUuidComments requestBody: content: application/json: example: meta: abc: cdef title: The comment title text: The comment text responses: "200": description: The comment response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: The Title text: The comment text "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/assets/{uuid}/detections: description: Create a new detection on an asset get: tags: - assets summary: List detections on an asset description: List detections on an asset operationId: getAssetsByUuidDetections responses: "200": description: The detection list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: gender: male age: 30 type: facedetection frameNumber: 0 bboxX: 0.3 bboxY: 0.2 bboxWidth: 0.12 bboxHeight: 0.2 confidence: 0.97 assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: gender: male age: 30 type: facedetection frameNumber: 0 bboxX: 0.3 bboxY: 0.2 bboxWidth: 0.12 bboxHeight: 0.2 confidence: 0.97 assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Create a new detection on an asset description: Create a new detection on an asset operationId: postAssetsByUuidDetections requestBody: content: application/json: example: meta: gender: male age: 30 type: facedetection frameNumber: 0 bboxX: 0.3 bboxY: 0.2 bboxWidth: 0.12 bboxHeight: 0.2 confidence: 0.97 responses: "200": description: The detection response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: gender: male age: 30 type: facedetection frameNumber: 0 bboxX: 0.3 bboxY: 0.2 bboxWidth: 0.12 bboxHeight: 0.2 confidence: 0.97 assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/assets/{uuid}/detections/{detectionUuid}: description: Delete a detection on an asset get: tags: - assets summary: Load a detection for an asset description: Load a detection for an asset operationId: getAssetsByUuidDetectionsByDetectionUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Update a detection for an asset description: Update a detection for an asset operationId: postAssetsByUuidDetectionsByDetectionUuid requestBody: content: application/json: example: meta: gender: female age: 25 type: facedetection frameNumber: 1 bboxX: 0.35 bboxY: 0.25 bboxWidth: 0.14 bboxHeight: 0.22 confidence: 0.95 responses: "200": description: The detection response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: gender: male age: 30 type: facedetection frameNumber: 0 bboxX: 0.3 bboxY: 0.2 bboxWidth: 0.12 bboxHeight: 0.2 confidence: 0.97 assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - assets summary: Delete a detection on an asset description: Delete a detection on an asset operationId: deleteAssetsByUuidDetectionsByDetectionUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: detectionUuid in: path description: UUID of the referenced detection required: true schema: type: string format: uuid /api/v1/assets/{uuid}/detections/bulk: description: Bulk create detections on an asset post: tags: - assets summary: Bulk create detections on an asset description: Bulk create detections on an asset operationId: postAssetsByUuidDetectionsBulk requestBody: content: application/json: example: detections: - meta: gender: male age: 30 type: facedetection frameNumber: 0 bboxX: 0.3 bboxY: 0.2 bboxWidth: 0.12 bboxHeight: 0.2 confidence: 0.97 - meta: gender: male age: 30 type: facedetection frameNumber: 0 bboxX: 0.3 bboxY: 0.2 bboxWidth: 0.12 bboxHeight: 0.2 confidence: 0.97 responses: "200": description: The detection bulk response content: application/json: example: detections: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: gender: male age: 30 type: facedetection frameNumber: 0 bboxX: 0.3 bboxY: 0.2 bboxWidth: 0.12 bboxHeight: 0.2 confidence: 0.97 assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: gender: male age: 30 type: facedetection frameNumber: 0 bboxX: 0.3 bboxY: 0.2 bboxWidth: 0.12 bboxHeight: 0.2 confidence: 0.97 assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 total: 2 created: 2 failed: 0 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/assets/{uuid}/fingerprints: description: Persist (upsert) a perceptual fingerprint component for an asset get: tags: - assets summary: List fingerprint components for an asset description: List fingerprint components for an asset operationId: getAssetsByUuidFingerprints responses: "200": description: The fingerprint component list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 nodeKind: fingerprint algorithm: metaloom-multisector-v1 sectorIndex: 0 fingerprint: a1b2c3d4e5f6 producerVersion: v1 _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Persist (upsert) a perceptual fingerprint component for an asset description: Persist (upsert) a perceptual fingerprint component for an asset operationId: postAssetsByUuidFingerprints requestBody: content: application/json: example: nodeKind: fingerprint algorithm: metaloom-multisector-v1 sectorIndex: 0 fingerprint: a1b2c3d4e5f6 producerVersion: v1 responses: "200": description: The fingerprint component response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 nodeKind: fingerprint algorithm: metaloom-multisector-v1 sectorIndex: 0 fingerprint: a1b2c3d4e5f6 producerVersion: v1 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/assets/{uuid}/fingerprints/{compUuid}: description: Load a fingerprint component for an asset get: tags: - assets summary: Load a fingerprint component for an asset description: Load a fingerprint component for an asset operationId: getAssetsByUuidFingerprintsByCompUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - assets summary: Delete a fingerprint component for an asset description: Delete a fingerprint component for an asset operationId: deleteAssetsByUuidFingerprintsByCompUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: compUuid in: path description: UUID of the referenced comp required: true schema: type: string format: uuid /api/v1/assets/{uuid}/json-comps: description: Persist (upsert) a generic JSON component result for an asset get: tags: - assets summary: List generic JSON component results for an asset description: List generic JSON component results for an asset operationId: getAssetsByUuidJsoncomps responses: "200": description: The json component list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 nodeKind: hello-world schemaType: hello-world variant: "" producerVersion: "1.0" data: file_size: 2048 word_count: 137 _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Persist (upsert) a generic JSON component result for an asset description: Persist (upsert) a generic JSON component result for an asset operationId: postAssetsByUuidJsoncomps requestBody: content: application/json: example: nodeKind: hello-world schemaType: hello-world variant: "" producerVersion: "1.0" data: file_size: 2048 word_count: 137 responses: "200": description: The json component response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 nodeKind: hello-world schemaType: hello-world variant: "" producerVersion: "1.0" data: file_size: 2048 word_count: 137 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/assets/{uuid}/json-comps/{compUuid}: description: Load a generic JSON component result for an asset get: tags: - assets summary: Load a generic JSON component result for an asset description: Load a generic JSON component result for an asset operationId: getAssetsByUuidJsoncompsByCompUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - assets summary: Delete a generic JSON component result for an asset description: Delete a generic JSON component result for an asset operationId: deleteAssetsByUuidJsoncompsByCompUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: compUuid in: path description: UUID of the referenced comp required: true schema: type: string format: uuid /api/v1/assets/{uuid}/node-results: description: Record (upsert) a node processing result for an asset get: tags: - assets summary: List node processing results for an asset description: List node processing results for an asset operationId: getAssetsByUuidNoderesults responses: "200": description: The node result list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 nodeKind: whisper nodeId: "" producerVersion: ggml-base state: SUCCESS origin: COMPUTED durationMs: 4200 resultRef: table: asset_transcript_comp uuids: - 86abc160-4da2-4951-a91f-da0c33fbc634 _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Record (upsert) a node processing result for an asset description: Record (upsert) a node processing result for an asset operationId: postAssetsByUuidNoderesults requestBody: content: application/json: example: nodeKind: whisper nodeId: "" producerVersion: ggml-base state: SUCCESS origin: COMPUTED durationMs: 4200 resultRef: table: asset_transcript_comp uuids: - 86abc160-4da2-4951-a91f-da0c33fbc634 responses: "200": description: The node result response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 nodeKind: whisper nodeId: "" producerVersion: ggml-base state: SUCCESS origin: COMPUTED durationMs: 4200 resultRef: table: asset_transcript_comp uuids: - 86abc160-4da2-4951-a91f-da0c33fbc634 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/assets/{uuid}/node-results/{nodeResultUuid}: description: Load a node processing result for an asset get: tags: - assets summary: Load a node processing result for an asset description: Load a node processing result for an asset operationId: getAssetsByUuidNoderesultsByNodeResultUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - assets summary: Delete a node processing result for an asset description: Delete a node processing result for an asset operationId: deleteAssetsByUuidNoderesultsByNodeResultUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: nodeResultUuid in: path description: UUID of the referenced nodeResult required: true schema: type: string format: uuid /api/v1/assets/{uuid}/reactions: description: Create a new reaction on an asset get: tags: - assets summary: List the reactions on an asset description: List the reactions on an asset operationId: getAssetsByUuidReactions responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Create a new reaction on an asset description: Create a new reaction on an asset operationId: postAssetsByUuidReactions responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/assets/{uuid}/reactions/{reactionUuid}: description: Delete the reaction on an asset get: tags: - assets summary: Load a reaction for an asset description: Load a reaction for an asset operationId: getAssetsByUuidReactionsByReactionUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Update an reaction for an asset description: Update an reaction for an asset operationId: postAssetsByUuidReactionsByReactionUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - assets summary: Delete the reaction on an asset description: Delete the reaction on an asset operationId: deleteAssetsByUuidReactionsByReactionUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: reactionUuid in: path description: UUID of the referenced reaction required: true schema: type: string format: uuid /api/v1/assets/{uuid}/segments: description: Replace the whole set of time-ranged segments for an asset (surplus rows from a shorter re-run are deleted) get: tags: - assets summary: List segment components for an asset description: List segment components for an asset operationId: getAssetsByUuidSegments responses: "200": description: The segment component list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 nodeKind: scene-detection segmentType: SCENE producerVersion: v1 seq: 0 timeFrom: 0 timeTo: 4200 score: 0.87 _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Replace the whole set of time-ranged segments for an asset (surplus rows from a shorter re-run are deleted) description: Replace the whole set of time-ranged segments for an asset (surplus rows from a shorter re-run are deleted) operationId: postAssetsByUuidSegments requestBody: content: application/json: example: nodeKind: scene-detection segmentType: SCENE producerVersion: v1 segments: - seq: 0 timeFrom: 0 timeTo: 4200 score: 0.87 - seq: 1 timeFrom: 4200 timeTo: 9100 score: 0.63 responses: "200": description: The segment component list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 nodeKind: scene-detection segmentType: SCENE producerVersion: v1 seq: 0 timeFrom: 0 timeTo: 4200 score: 0.87 _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/assets/{uuid}/segments/{compUuid}: description: Load a segment component for an asset get: tags: - assets summary: Load a segment component for an asset description: Load a segment component for an asset operationId: getAssetsByUuidSegmentsByCompUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - assets summary: Delete a segment component for an asset description: Delete a segment component for an asset operationId: deleteAssetsByUuidSegmentsByCompUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: compUuid in: path description: UUID of the referenced comp required: true schema: type: string format: uuid /api/v1/assets/{uuid}/tags: description: Tag the asset post: tags: - assets summary: Tag the asset description: Tag the asset operationId: postAssetsByUuidTags responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/assets/{uuid}/tags/{tagUuid}: description: Remove a tag from an asset delete: tags: - assets summary: Remove a tag from an asset description: Remove a tag from an asset operationId: deleteAssetsByUuidTagsByTagUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: tagUuid in: path description: UUID of the referenced tag required: true schema: type: string format: uuid /api/v1/assets/{uuid}/tasks: description: List the tasks assigned to the asset get: tags: - assets summary: List the tasks assigned to the asset description: List the tasks assigned to the asset operationId: getAssetsByUuidTasks responses: "200": description: The task list response content: application/json: example: data: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} meta: abc: cdef title: The title priority: MEDIUM taskStatus: PENDING dueDate: 2026-08-01T12:00:00Z comments: [] _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/assets/{uuid}/tasks/{taskUuid}: description: Assign an existing task to the asset post: tags: - assets summary: Assign an existing task to the asset description: Assign an existing task to the asset operationId: postAssetsByUuidTasksByTaskUuid responses: "200": description: The task response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} meta: abc: cdef title: The title priority: MEDIUM taskStatus: PENDING dueDate: 2026-08-01T12:00:00Z comments: [] "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - assets summary: Unassign a task from the asset description: Unassign a task from the asset operationId: deleteAssetsByUuidTasksByTaskUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: taskUuid in: path description: UUID of the referenced task required: true schema: type: string format: uuid /api/v1/assets/{uuid}/transcripts: description: Create a new transcript for an asset get: tags: - assets summary: List transcripts for an asset description: List transcripts for an asset operationId: getAssetsByUuidTranscripts responses: "200": description: The transcript list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z source: whisper producerVersion: ggml-base streamIndex: 0 lang: en transcriptText: Hello world. This is a test transcription. duration: 5000 model: ggml-base transcriptJson: segments: - text: Hello world. from: 0 to: 2500 - text: This is a test transcription. from: 2500 to: 5000 assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z source: whisper producerVersion: ggml-base streamIndex: 0 lang: en transcriptText: Hello world. This is a test transcription. duration: 5000 model: ggml-base transcriptJson: segments: - text: Hello world. from: 0 to: 2500 - text: This is a test transcription. from: 2500 to: 5000 assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Create a new transcript for an asset description: Create a new transcript for an asset operationId: postAssetsByUuidTranscripts requestBody: content: application/json: example: source: whisper producerVersion: ggml-base streamIndex: 0 lang: en transcriptText: Hello world. This is a test transcription. duration: 5000 model: ggml-base transcriptJson: segments: - text: Hello world. from: 0 to: 2500 - text: This is a test transcription. from: 2500 to: 5000 responses: "200": description: The transcript response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z source: whisper producerVersion: ggml-base streamIndex: 0 lang: en transcriptText: Hello world. This is a test transcription. duration: 5000 model: ggml-base transcriptJson: segments: - text: Hello world. from: 0 to: 2500 - text: This is a test transcription. from: 2500 to: 5000 assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/assets/{uuid}/transcripts/{transcriptUuid}: description: Load a transcript for an asset get: tags: - assets summary: Load a transcript for an asset description: Load a transcript for an asset operationId: getAssetsByUuidTranscriptsByTranscriptUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Update a transcript for an asset description: Update a transcript for an asset operationId: postAssetsByUuidTranscriptsByTranscriptUuid requestBody: content: application/json: example: lang: de transcriptText: Hallo Welt. Dies ist eine Testtranskription. duration: 5200 transcriptJson: segments: - text: Hallo Welt. from: 0 to: 2600 - text: Dies ist eine Testtranskription. from: 2600 to: 5200 responses: "200": description: The transcript response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z source: whisper producerVersion: ggml-base streamIndex: 0 lang: en transcriptText: Hello world. This is a test transcription. duration: 5000 model: ggml-base transcriptJson: segments: - text: Hello world. from: 0 to: 2500 - text: This is a test transcription. from: 2500 to: 5000 assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - assets summary: Delete a transcript for an asset description: Delete a transcript for an asset operationId: deleteAssetsByUuidTranscriptsByTranscriptUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: transcriptUuid in: path description: UUID of the referenced transcript required: true schema: type: string format: uuid /api/v1/assets/bulk/create: description: Bulk create assets post: tags: - assets summary: Bulk create assets description: Bulk create assets operationId: postAssetsBulkCreate requestBody: content: application/json: example: assets: - meta: abc: cdef geo: lon: 32.56 lat: 52.156 timeline: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z image: dominantColor: "#FFFF00" embeddings: [] - meta: abc: cdef geo: lon: 32.56 lat: 52.156 timeline: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z image: dominantColor: "#FFFF00" embeddings: [] responses: "200": description: The asset bulk response content: application/json: example: items: - index: 0 uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: CREATED total: 2 created: 2 failed: 0 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/assets/bulk/update: description: Bulk update assets post: tags: - assets summary: Bulk update assets description: Bulk update assets operationId: postAssetsBulkUpdate requestBody: content: application/json: example: assets: - hashes: sha512: 0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123 update: meta: abc: cdef timeline: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z image: dominantColor: "#FFFF00" geo: lon: 32.56 lat: 52.156 responses: "200": description: The asset bulk response content: application/json: example: items: - index: 0 uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: CREATED total: 2 created: 2 failed: 0 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/assets/sha512/{sha512}: description: Load an asset by SHA-512 hash get: tags: - assets summary: Load an asset by SHA-512 hash description: Load an asset by SHA-512 hash operationId: getAssetsSha512BySha512 responses: "200": description: The asset response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef geo: lon: 32.56 lat: 52.156 tags: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: red annotations: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue collections: [] embeddings: [] file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z hashes: sha512: 0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123 sha256: f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2 md5: d8e8fca2dc0f896fd7cb4cb0031ba249 geoComponents: [] imageComponents: - dominantColor: "#FFFF00" videoComponents: - width: 4000 height: 2250 duration: 20000 audioComponents: - channels: 2 encoding: mp3 samplingRate: 48000 bpm: 120 documentComponents: [] locations: - status: {} poolUuid: 86abc160-4da2-4951-a91f-da0c33fbc634 mimeType: video/mp4 state: PRESENT license: CC-BY-4.0 filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" put: tags: - assets summary: Replace an asset by SHA-512 hash. All replaceable fields must be present in the request body. description: Replace an asset by SHA-512 hash. All replaceable fields must be present in the request body. operationId: putAssetsSha512BySha512 requestBody: content: application/json: example: meta: abc: cdef timeline: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z image: dominantColor: "#FFFF00" geo: lon: 32.56 lat: 52.156 responses: "200": description: The asset response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef geo: lon: 32.56 lat: 52.156 tags: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: red annotations: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue collections: [] embeddings: [] file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z hashes: sha512: 0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123 sha256: f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2 md5: d8e8fca2dc0f896fd7cb4cb0031ba249 geoComponents: [] imageComponents: - dominantColor: "#FFFF00" videoComponents: - width: 4000 height: 2250 duration: 20000 audioComponents: - channels: 2 encoding: mp3 samplingRate: 48000 bpm: 120 documentComponents: [] locations: - status: {} poolUuid: 86abc160-4da2-4951-a91f-da0c33fbc634 mimeType: video/mp4 state: PRESENT license: CC-BY-4.0 filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - assets summary: Update an asset by SHA-512 hash description: Update an asset by SHA-512 hash operationId: postAssetsSha512BySha512 requestBody: content: application/json: example: meta: abc: cdef timeline: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z image: dominantColor: "#FFFF00" geo: lon: 32.56 lat: 52.156 responses: "200": description: The asset response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef geo: lon: 32.56 lat: 52.156 tags: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: red annotations: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue collections: [] embeddings: [] file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z hashes: sha512: 0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123 sha256: f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2 md5: d8e8fca2dc0f896fd7cb4cb0031ba249 geoComponents: [] imageComponents: - dominantColor: "#FFFF00" videoComponents: - width: 4000 height: 2250 duration: 20000 audioComponents: - channels: 2 encoding: mp3 samplingRate: 48000 bpm: 120 documentComponents: [] locations: - status: {} poolUuid: 86abc160-4da2-4951-a91f-da0c33fbc634 mimeType: video/mp4 state: PRESENT license: CC-BY-4.0 filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - assets summary: Delete an asset by SHA-512 hash description: Delete an asset by SHA-512 hash operationId: deleteAssetsSha512BySha512 responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" patch: tags: - assets summary: Partially update an asset by SHA-512 hash. Only the fields present in the request body are modified. description: Partially update an asset by SHA-512 hash. Only the fields present in the request body are modified. operationId: patchAssetsSha512BySha512 requestBody: content: application/json: example: meta: abc: cdef timeline: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z image: dominantColor: "#FFFF00" geo: lon: 32.56 lat: 52.156 responses: "200": description: The asset response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef geo: lon: 32.56 lat: 52.156 tags: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: red annotations: - status: {} meta: abc: cdef title: Intro Feedback area: from: 0 to: 10 description: The very nice intro tasks: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: {} title: Fix text offset here description: The text is not aligned with the title comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 comments: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: {} title: Great work! text: What a great choice of colors! social: rating: stars: 10 upVotes: 42 downVotes: 0 reactions: SATISFIED: 10 thumbnail: ??? tags: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 name: blue collections: [] embeddings: [] file: mimeType: video/mp4 filename: bigbuckbunny-4k.mp4 size: 42000000 origin: https://www.youtube.com/watch?v=aqz-KE-bpKQ firstSeen: 2018-10-12T14:15:06Z hashes: sha512: 0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123 sha256: f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2 md5: d8e8fca2dc0f896fd7cb4cb0031ba249 geoComponents: [] imageComponents: - dominantColor: "#FFFF00" videoComponents: - width: 4000 height: 2250 duration: 20000 audioComponents: - channels: 2 encoding: mp3 samplingRate: 48000 bpm: 120 documentComponents: [] locations: - status: {} poolUuid: 86abc160-4da2-4951-a91f-da0c33fbc634 mimeType: video/mp4 state: PRESENT license: CC-BY-4.0 filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: sha512 in: path description: SHA-512 hash of the asset binary required: true schema: pattern: "^[a-fA-F0-9]{128}$" type: string /api/v1/assets/upload: description: Upload a file to create an asset. Expects a multipart request with one file part and a 'libraryUuid' form field. post: tags: - assets summary: Upload a file to create an asset. Expects a multipart request with one file part and a 'libraryUuid' form field. description: Upload a file to create an asset. Expects a multipart request with one file part and a 'libraryUuid' form field. operationId: postAssetsUpload responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/attachments: description: Create new attachment get: tags: - attachments summary: Load a paged list of attachments description: Load a paged list of attachments operationId: getAttachments parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The attachment list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef filename: flower.jpg size: 0 - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef filename: flower.jpg size: 0 _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - attachments summary: Create new attachment description: Create new attachment operationId: postAttachments responses: "200": description: The attachment response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef filename: flower.jpg size: 0 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/attachments/{uuid}: description: Update a attachment get: tags: - attachments summary: Load a attachment description: Load a attachment operationId: getAttachmentsByUuid responses: "200": description: The attachment response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef filename: flower.jpg size: 0 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - attachments summary: Update a attachment description: Update a attachment operationId: postAttachmentsByUuid requestBody: content: application/json: example: meta: abc: cdef filename: updated_flower.jpg responses: "200": description: The attachment response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef filename: flower.jpg size: 0 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - attachments summary: Delete a attachment description: Delete a attachment operationId: deleteAttachmentsByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/auth/oauth2/callback: description: Handle OAuth2 callback from identity provider get: tags: - auth summary: Handle OAuth2 callback from identity provider description: Handle OAuth2 callback from identity provider operationId: getAuthOauth2Callback responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" security: [] /api/v1/auth/oauth2/login: description: Initiate OAuth2 login flow get: tags: - auth summary: Initiate OAuth2 login flow description: Initiate OAuth2 login flow operationId: getAuthOauth2Login responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" security: [] /api/v1/auth/oauth2/logout: description: Logout and clear session cookie get: tags: - auth summary: Logout and clear session cookie description: Logout and clear session cookie operationId: getAuthOauth2Logout responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" security: [] /api/v1/binaries: description: Create new binary get: tags: - binaries summary: Load a paged list of binaries description: Load a paged list of binaries operationId: getBinaries parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The location list response content: application/json: example: data: - status: {} filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie - status: {} filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - binaries summary: Create new binary description: Create new binary operationId: postBinaries requestBody: content: application/json: example: {} responses: "200": description: The location response content: application/json: example: status: {} filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/binaries/{uuid}: description: Update a binary get: tags: - binaries summary: Load a binary description: Load a binary operationId: getBinariesByUuid responses: "200": description: The location response content: application/json: example: status: {} filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - binaries summary: Update a binary description: Update a binary operationId: postBinariesByUuid requestBody: content: application/json: example: {} responses: "200": description: The location response content: application/json: example: status: {} filesystem: path: /the-current-path/bigbuckbunny-4k.mp4 filekey: inode: 42 stDev: 12 edate: 12 edateNano: 3 lastSeen: 2018-11-20T20:12:01Z s3: bucket: big_bucket objectPath: themovie "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - binaries summary: Delete a binary description: Delete a binary operationId: deleteBinariesByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/blacklists: description: Create new blacklist entry get: tags: - blacklists summary: Load a paged list of blacklist entries description: Load a paged list of blacklist entries operationId: getBlacklists parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The blacklist list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: Blocked asset assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: Blocked asset assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - blacklists summary: Create new blacklist entry description: Create new blacklist entry operationId: postBlacklists requestBody: content: application/json: example: meta: abc: cdef name: New blacklist entry assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 responses: "200": description: The blacklist response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: Blocked asset assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/blacklists/{uuid}: description: Update a blacklist entry get: tags: - blacklists summary: Load a blacklist entry description: Load a blacklist entry operationId: getBlacklistsByUuid responses: "200": description: The blacklist response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: Blocked asset assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - blacklists summary: Update a blacklist entry description: Update a blacklist entry operationId: postBlacklistsByUuid requestBody: content: application/json: example: meta: abc: cdef name: Updated blacklist entry responses: "200": description: The blacklist response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: Blocked asset assetUuid: f04e89d0-076d-4d90-b192-715a25a2cd59 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - blacklists summary: Delete a blacklist entry description: Delete a blacklist entry operationId: deleteBlacklistsByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/chat-sessions: description: Capture a chat as a new chat session get: tags: - chat-sessions summary: List chat sessions (scope=mine|published) description: List chat sessions (scope=mine|published) operationId: getChatsessions responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - chat-sessions summary: Capture a chat as a new chat session description: Capture a chat as a new chat session operationId: postChatsessions responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/chat-sessions/{uuid}: description: Edit a chat session get: tags: - chat-sessions summary: Load a chat session description: Load a chat session operationId: getChatsessionsByUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - chat-sessions summary: Edit a chat session description: Edit a chat session operationId: postChatsessionsByUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - chat-sessions summary: Delete a chat session description: Delete a chat session operationId: deleteChatsessionsByUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/chat-sessions/{uuid}/context: description: Read the context references of a chat session get: tags: - chat-sessions summary: Read the context references of a chat session description: Read the context references of a chat session operationId: getChatsessionsByUuidContext responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" put: tags: - chat-sessions summary: Replace the context references of a chat session description: Replace the context references of a chat session operationId: putChatsessionsByUuidContext responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/chat-sessions/{uuid}/publish: description: Publish a chat session to the shared library post: tags: - chat-sessions summary: Publish a chat session to the shared library description: Publish a chat session to the shared library operationId: postChatsessionsByUuidPublish responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/chat-sessions/{uuid}/unpublish: description: Unpublish a chat session post: tags: - chat-sessions summary: Unpublish a chat session description: Unpublish a chat session operationId: postChatsessionsByUuidUnpublish responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/chats: description: Create a new chat session get: tags: - chats summary: Load a paged list of chat sessions description: Load a paged list of chat sessions operationId: getChats parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The chat list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: Campaign asset review messages: - role: user content: Show me the latest assets in Campaign Alpha - role: assistant content: Here are the most recently updated assets in Campaign Alpha. references: - type: asset id: a1 label: Hero_Campaign_30s_Final.mp4 - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: Campaign asset review messages: - role: user content: Show me the latest assets in Campaign Alpha - role: assistant content: Here are the most recently updated assets in Campaign Alpha. references: - type: asset id: a1 label: Hero_Campaign_30s_Final.mp4 _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - chats summary: Create a new chat session description: Create a new chat session operationId: postChats requestBody: content: application/json: example: meta: abc: cdef title: New chat session messages: - role: user content: Show me the latest assets in Campaign Alpha - role: assistant content: Here are the most recently updated assets in Campaign Alpha. references: - type: asset id: a1 label: Hero_Campaign_30s_Final.mp4 responses: "200": description: The chat response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: Campaign asset review messages: - role: user content: Show me the latest assets in Campaign Alpha - role: assistant content: Here are the most recently updated assets in Campaign Alpha. references: - type: asset id: a1 label: Hero_Campaign_30s_Final.mp4 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/chats/{uuid}: description: Update a chat session get: tags: - chats summary: Load a chat session description: Load a chat session operationId: getChatsByUuid responses: "200": description: The chat response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: Campaign asset review messages: - role: user content: Show me the latest assets in Campaign Alpha - role: assistant content: Here are the most recently updated assets in Campaign Alpha. references: - type: asset id: a1 label: Hero_Campaign_30s_Final.mp4 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - chats summary: Update a chat session description: Update a chat session operationId: postChatsByUuid requestBody: content: application/json: example: meta: abc: cdef title: Updated chat title messages: - role: user content: Show me the latest assets in Campaign Alpha - role: assistant content: Here are the most recently updated assets in Campaign Alpha. references: - type: asset id: a1 label: Hero_Campaign_30s_Final.mp4 responses: "200": description: The chat response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: Campaign asset review messages: - role: user content: Show me the latest assets in Campaign Alpha - role: assistant content: Here are the most recently updated assets in Campaign Alpha. references: - type: asset id: a1 label: Hero_Campaign_30s_Final.mp4 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - chats summary: Delete a chat session description: Delete a chat session operationId: deleteChatsByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/chats/{uuid}/stream: description: Send a chat message to the agent and stream the run events back as Server-Sent Events post: tags: - chats summary: Send a chat message to the agent and stream the run events back as Server-Sent Events description: Send a chat message to the agent and stream the run events back as Server-Sent Events operationId: postChatsByUuidStream responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - chats summary: Cancel the active agent run of the chat session description: Cancel the active agent run of the chat session operationId: deleteChatsByUuidStream responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/clusters: description: Create a new cluster get: tags: - clusters summary: Load a paged list of clusters description: Load a paged list of clusters operationId: getClusters parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The cluster list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: The cluster name - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: The cluster name _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - clusters summary: Create a new cluster description: Create a new cluster operationId: postClusters requestBody: content: application/json: example: name: The cluster name meta: abc: cdef responses: "200": description: The cluster response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: The cluster name "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/clusters/{uuid}: description: Update a cluster get: tags: - clusters summary: Load a cluster description: Load a cluster operationId: getClustersByUuid responses: "200": description: The cluster response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: The cluster name "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - clusters summary: Update a cluster description: Update a cluster operationId: postClustersByUuid requestBody: content: application/json: example: meta: abc: cdef name: The cluster name responses: "200": description: The cluster response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: The cluster name "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - clusters summary: Delete a cluster description: Delete a cluster operationId: deleteClustersByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/collections: description: Create new collection get: tags: - collections summary: Load a paged list of collections description: Load a paged list of collections operationId: getCollections parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The collection list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: The collection name - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: The collection name _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - collections summary: Create new collection description: Create new collection operationId: postCollections requestBody: content: application/json: example: meta: abc: cdef name: The collection name responses: "200": description: The collection response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: The collection name "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/collections/{uuid}: description: Update a collection get: tags: - collections summary: Load a collection description: Load a collection operationId: getCollectionsByUuid responses: "200": description: The collection response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: The collection name "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - collections summary: Update a collection description: Update a collection operationId: postCollectionsByUuid requestBody: content: application/json: example: meta: abc: cdef name: The collection name responses: "200": description: The collection response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: The collection name "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - collections summary: Delete a collection description: Delete a collection operationId: deleteCollectionsByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/comments: description: Create new comment get: tags: - comments summary: Load a paged list of comments description: Load a paged list of comments operationId: getComments parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The comment list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: The Title text: The comment text - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: The Title text: The comment text _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - comments summary: Create new comment description: Create new comment operationId: postComments requestBody: content: application/json: example: meta: abc: cdef title: The comment title text: The comment text responses: "200": description: The comment response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: The Title text: The comment text "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/comments/{commentUuid}/reactions: description: Create a reaction on a comment get: tags: - comments summary: Load a paged list for reactions on a specific comment description: Load a paged list for reactions on a specific comment operationId: getCommentsByCommentUuidReactions responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - comments summary: Create a reaction on a comment description: Create a reaction on a comment operationId: postCommentsByCommentUuidReactions responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: commentUuid in: path description: UUID of the referenced comment required: true schema: type: string format: uuid /api/v1/comments/{commentUuid}/reactions/{reactionUuid}: description: Delete the commment for the reaction get: tags: - comments summary: Load a specific reaction for a comment description: Load a specific reaction for a comment operationId: getCommentsByCommentUuidReactionsByReactionUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - comments summary: Update a specific reaction on a comment description: Update a specific reaction on a comment operationId: postCommentsByCommentUuidReactionsByReactionUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - comments summary: Delete the commment for the reaction description: Delete the commment for the reaction operationId: deleteCommentsByCommentUuidReactionsByReactionUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: commentUuid in: path description: UUID of the referenced comment required: true schema: type: string format: uuid - name: reactionUuid in: path description: UUID of the referenced reaction required: true schema: type: string format: uuid /api/v1/comments/{uuid}: description: Update a comment get: tags: - comments summary: Load a comment description: Load a comment operationId: getCommentsByUuid responses: "200": description: The comment response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: The Title text: The comment text "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - comments summary: Update a comment description: Update a comment operationId: postCommentsByUuid requestBody: content: application/json: example: meta: abc: cdef title: The comment title text: The comment text responses: "200": description: The comment response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: The Title text: The comment text "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - comments summary: Delete a comment description: Delete a comment operationId: deleteCommentsByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/embeddings: description: Create new embedding get: tags: - embeddings summary: Load a paged list of embeddings description: Load a paged list of embeddings operationId: getEmbeddings parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The embedding list response content: application/json: example: data: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} meta: abc: cdef - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} meta: abc: cdef _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - embeddings summary: Create new embedding description: Create new embedding operationId: postEmbeddings requestBody: content: application/json: example: meta: abc: cdef vector: - 0.42 - 0.24 - 0.44 - 21.5 responses: "200": description: The embedding response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} meta: abc: cdef "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/embeddings/{embeddingUuid}/attachments: description: Create a new attachment for the embedding get: tags: - embeddings summary: List the attachments for the embedding description: List the attachments for the embedding operationId: getEmbeddingsByEmbeddingUuidAttachments responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - embeddings summary: Create a new attachment for the embedding description: Create a new attachment for the embedding operationId: postEmbeddingsByEmbeddingUuidAttachments responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: embeddingUuid in: path description: UUID of the referenced embedding required: true schema: type: string format: uuid /api/v1/embeddings/{uuid}: description: Update a embedding get: tags: - embeddings summary: Load a embedding description: Load a embedding operationId: getEmbeddingsByUuid responses: "200": description: The embedding response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} meta: abc: cdef "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - embeddings summary: Update a embedding description: Update a embedding operationId: postEmbeddingsByUuid requestBody: content: application/json: example: meta: abc: cdef type: VIDEO4J_FINGERPRINT_V2 responses: "200": description: The embedding response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} meta: abc: cdef "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - embeddings summary: Delete a embedding description: Delete a embedding operationId: deleteEmbeddingsByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/graphql: description: Execute a GraphQL query post: tags: - graphql summary: Execute a GraphQL query description: Execute a GraphQL query operationId: postGraphql responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/groups: description: Create new group get: tags: - groups summary: Load a paged list of groups description: Load a paged list of groups operationId: getGroups responses: "200": description: The group list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: Guests - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: Guests _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - groups summary: Create new group description: Create new group operationId: postGroups requestBody: content: application/json: example: name: Guests meta: abc: cdef responses: "200": description: The group response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: Guests "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/groups/{uuid}: description: Update a group get: tags: - groups summary: Load a group description: Load a group operationId: getGroupsByUuid responses: "200": description: The group response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: Guests "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" put: tags: - groups summary: Replace a group. All replaceable fields must be present in the request body. description: Replace a group. All replaceable fields must be present in the request body. operationId: putGroupsByUuid requestBody: content: application/json: example: name: NewGuests meta: abc: cdef responses: "200": description: The group response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: Guests "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - groups summary: Update a group description: Update a group operationId: postGroupsByUuid requestBody: content: application/json: example: name: NewGuests meta: abc: cdef responses: "200": description: The group response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: Guests "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - groups summary: Delete a group description: Delete a group operationId: deleteGroupsByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" patch: tags: - groups summary: Partially update a group. Only the fields present in the request body are modified. description: Partially update a group. Only the fields present in the request body are modified. operationId: patchGroupsByUuid requestBody: content: application/json: example: name: NewGuests meta: abc: cdef responses: "200": description: The group response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: Guests "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/health: description: Health check endpoint get: tags: - health summary: Health check endpoint description: Health check endpoint operationId: getHealth responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" security: [] /api/v1/libraries: description: Create a new library get: tags: - libraries summary: Load a paged list of librarys description: Load a paged list of librarys operationId: getLibraries parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The library list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: MyProject - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: MyProject _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - libraries summary: Create a new library description: Create a new library operationId: postLibraries requestBody: content: application/json: example: name: MyProject meta: abc: cdef responses: "200": description: The library response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: MyProject "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/libraries/{uuid}: description: Update a library get: tags: - libraries summary: Load a library description: Load a library operationId: getLibrariesByUuid responses: "200": description: The library response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: MyProject "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - libraries summary: Update a library description: Update a library operationId: postLibrariesByUuid requestBody: content: application/json: example: name: NewProject meta: abc: cdef responses: "200": description: The library response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: MyProject "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - libraries summary: Delete a library description: Delete a library operationId: deleteLibrariesByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/login: description: Login the user with the provided credentials post: tags: - login summary: Login the user with the provided credentials description: Login the user with the provided credentials operationId: postLogin responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" security: [] /api/v1/me: description: Load the currently authenticated user get: tags: - me summary: Load the currently authenticated user description: Load the currently authenticated user operationId: getMe responses: "200": description: The user response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef username: joedoe firstname: Joe lastname: Doe email: joedoe@metaloom.io enabled: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/memory: description: List the notes of a memory scope get: tags: - memory summary: List the notes of a memory scope description: List the notes of a memory scope operationId: getMemory responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/memory-deny-rules: description: Load a paged list of memory deny rules get: tags: - memory-deny-rules summary: Load a paged list of memory deny rules description: Load a paged list of memory deny rules operationId: getMemorydenyrules responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - memory-deny-rules summary: Create a new memory deny rule description: Create a new memory deny rule operationId: postMemorydenyrules responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/memory-deny-rules/{uuid}: description: Load a memory deny rule get: tags: - memory-deny-rules summary: Load a memory deny rule description: Load a memory deny rule operationId: getMemorydenyrulesByUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - memory-deny-rules summary: Update a memory deny rule description: Update a memory deny rule operationId: postMemorydenyrulesByUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - memory-deny-rules summary: Delete a memory deny rule description: Delete a memory deny rule operationId: deleteMemorydenyrulesByUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/memory/entry: description: Read one memory note get: tags: - memory summary: Read one memory note description: Read one memory note operationId: getMemoryEntry responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" put: tags: - memory summary: Create or update a memory note description: Create or update a memory note operationId: putMemoryEntry responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - memory summary: Create a memory note description: Create a memory note operationId: postMemoryEntry responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - memory summary: Delete a memory note description: Delete a memory note operationId: deleteMemoryEntry responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/memory/scopes: description: "List the memory scopes available to the current user, with usage\ \ and quota" get: tags: - memory summary: "List the memory scopes available to the current user, with usage and\ \ quota" description: "List the memory scopes available to the current user, with usage\ \ and quota" operationId: getMemoryScopes responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/openapi: description: Load the OpenAPI spec of this server (YAML) get: tags: - info summary: Load the OpenAPI spec of this server (YAML) description: Load the OpenAPI spec of this server (YAML) operationId: getOpenapi responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" security: [] /api/v1/openapi.json: description: Load the OpenAPI spec of this server (JSON) get: tags: - info summary: Load the OpenAPI spec of this server (JSON) description: Load the OpenAPI spec of this server (JSON) operationId: getOpenapijson responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" security: [] /api/v1/openapi.yaml: description: Load the OpenAPI spec of this server (YAML) get: tags: - info summary: Load the OpenAPI spec of this server (YAML) description: Load the OpenAPI spec of this server (YAML) operationId: getOpenapiyaml responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" security: [] /api/v1/persons: description: Create a new person get: tags: - persons summary: Load a paged list of persons description: Load a paged list of persons operationId: getPersons parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The person list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef alias: jdoe firstname: John lastname: Doe - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef alias: jdoe firstname: John lastname: Doe _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - persons summary: Create a new person description: Create a new person operationId: postPersons requestBody: content: application/json: example: alias: jdoe firstname: John lastname: Doe meta: abc: cdef responses: "200": description: The person response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef alias: jdoe firstname: John lastname: Doe "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/persons/{uuid}: description: Update a person get: tags: - persons summary: Load a person description: Load a person operationId: getPersonsByUuid responses: "200": description: The person response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef alias: jdoe firstname: John lastname: Doe "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - persons summary: Update a person description: Update a person operationId: postPersonsByUuid requestBody: content: application/json: example: alias: jdoe_updated firstname: Jane lastname: Doe meta: abc: cdef responses: "200": description: The person response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef alias: jdoe firstname: John lastname: Doe "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - persons summary: Delete a person description: Delete a person operationId: deletePersonsByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/pipeline/content-types: description: Load all pipeline content types get: tags: - pipeline summary: Load all pipeline content types description: Load all pipeline content types operationId: getPipelineContenttypes responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/pipeline/node-descriptors: description: Load all pipeline node descriptors get: tags: - pipeline summary: Load all pipeline node descriptors description: Load all pipeline node descriptors operationId: getPipelineNodedescriptors responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/pipeline/node-descriptors/{kind}: description: Load a pipeline node descriptor by kind get: tags: - pipeline summary: Load a pipeline node descriptor by kind description: Load a pipeline node descriptor by kind operationId: getPipelineNodedescriptorsByKind responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: kind in: path description: Pipeline node kind required: true schema: type: string /api/v1/pipelines: description: Create a new pipeline get: tags: - pipelines summary: Load a paged list of pipelines description: Load a paged list of pipelines operationId: getPipelines parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The pipeline list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef versionUuid: 1a0879da-1037-4ac7-b70f-06f3b32a16de versionNumber: 1 name: my-pipeline description: A sample pipeline definition: nodes: [] enabled: true priority: 10 dryRun: false - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef versionUuid: 3cef2770-a2da-4924-a0c2-904f5e9f339e versionNumber: 1 name: my-pipeline description: A sample pipeline definition: nodes: [] enabled: true priority: 10 dryRun: false _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - pipelines summary: Create a new pipeline description: Create a new pipeline operationId: postPipelines requestBody: content: application/json: example: name: my-pipeline description: A new pipeline definition: nodes: [] enabled: true priority: 10 dryRun: false meta: abc: cdef responses: "200": description: The pipeline response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef versionUuid: c104a58f-0680-4bfb-8297-e99cb4f64ada versionNumber: 1 name: my-pipeline description: A sample pipeline definition: nodes: [] enabled: true priority: 10 dryRun: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/pipelines/{uuid}: description: Update a pipeline get: tags: - pipelines summary: Load a pipeline description: Load a pipeline operationId: getPipelinesByUuid responses: "200": description: The pipeline response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef versionUuid: 2b4e5693-5a98-4b21-aa4a-3c87ea187685 versionNumber: 1 name: my-pipeline description: A sample pipeline definition: nodes: [] enabled: true priority: 10 dryRun: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - pipelines summary: Update a pipeline description: Update a pipeline operationId: postPipelinesByUuid requestBody: content: application/json: example: name: updated-pipeline description: An updated pipeline enabled: false meta: abc: cdef responses: "200": description: The pipeline response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef versionUuid: d5a4663d-3411-4cda-a0a4-24ab48fe4bf6 versionNumber: 1 name: my-pipeline description: A sample pipeline definition: nodes: [] enabled: true priority: 10 dryRun: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - pipelines summary: Delete a pipeline and all its versions description: Delete a pipeline and all its versions operationId: deletePipelinesByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/pipelines/{uuid}/run: description: Trigger execution of a pipeline post: tags: - pipelines summary: Trigger execution of a pipeline description: Trigger execution of a pipeline operationId: postPipelinesByUuidRun requestBody: content: application/json: example: mediaUuids: - f04e89d0-076d-4d90-b192-715a25a2cd59 - 86abc160-4da2-4951-a91f-da0c33fbc634 path: /media/library dryRun: false responses: "202": description: The pipeline run response content: application/json: example: runUuid: 328ba549-1c96-4527-995b-6b08297eb48f processorNodeId: cortex-01 dispatched: true message: Pipeline run dispatched "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/pipelines/{uuid}/runs: description: Load a paged list of pipeline runs get: tags: - pipelines summary: Load a paged list of pipeline runs description: Load a paged list of pipeline runs operationId: getPipelinesByUuidRuns parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The pipeline run list response content: application/json: example: data: - uuid: 89b750d7-4739-4710-81b9-1c2977f8f7fb pipelineUuid: dc781746-2dbd-40af-8205-bc2db3c7c2ed pipelineVersion: 1 started: 2026-07-26T11:48:32.866566494Z finished: 2026-07-26T11:48:32.866576874Z status: SUCCESS mediaCount: 100 successCount: 95 failureCount: 3 skippedCount: 2 dryRun: false durationMs: 45000 - uuid: 01b5fc43-a42b-464c-b847-d90afd5ed2d3 pipelineUuid: 47ae7e7c-0a9e-4a0b-a274-a0b7600f2cbc pipelineVersion: 1 started: 2026-07-26T11:48:32.866594264Z finished: 2026-07-26T11:48:32.866596754Z status: SUCCESS mediaCount: 100 successCount: 95 failureCount: 3 skippedCount: 2 dryRun: false durationMs: 45000 _metainfo: perPage: 30 totalCount: 2 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/pipelines/{uuid}/runs/{runUuid}: description: Load a single pipeline run get: tags: - pipelines summary: Load a single pipeline run description: Load a single pipeline run operationId: getPipelinesByUuidRunsByRunUuid responses: "200": description: The pipeline run detail response content: application/json: example: uuid: c86672ed-f77f-405b-85fb-31a0346e68b8 pipelineUuid: 2c1d28f5-a9dd-4fa7-aa85-6096269dd14f pipelineVersion: 1 started: 2026-07-26T11:48:32.866649814Z finished: 2026-07-26T11:48:32.866652464Z status: SUCCESS mediaCount: 100 successCount: 95 failureCount: 3 skippedCount: 2 dryRun: false durationMs: 45000 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: runUuid in: path description: UUID of the referenced run required: true schema: type: string format: uuid /api/v1/pipelines/{uuid}/runs/{runUuid}/cancel: description: Cancel an in-flight pipeline run post: tags: - pipelines summary: Cancel an in-flight pipeline run description: Cancel an in-flight pipeline run operationId: postPipelinesByUuidRunsByRunUuidCancel responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: runUuid in: path description: UUID of the referenced run required: true schema: type: string format: uuid /api/v1/pipelines/{uuid}/runs/{runUuid}/items: description: Load a paged list of items for a pipeline run get: tags: - pipelines summary: Load a paged list of items for a pipeline run description: Load a paged list of items for a pipeline run operationId: getPipelinesByUuidRunsByRunUuidItems parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The pipeline run item list response content: application/json: example: data: - uuid: b80f0286-c8cb-4633-b7c6-ff6c6a24dd21 runUuid: cd59b4d6-2ad8-43d6-9e1b-f6c9fec2ecb9 itemSeq: 1 mediaPath: /media/example.mp4 sha512: 0f8ef1c9... sizeBytes: 1048576 state: SUCCESS - uuid: b1d711dd-0e7c-4575-b9e4-bf4ee0638546 runUuid: 2e7a376d-c072-462e-a84f-7e87273b70e2 itemSeq: 1 mediaPath: /media/example.mp4 sha512: 0f8ef1c9... sizeBytes: 1048576 state: SUCCESS _metainfo: perPage: 25 totalCount: 2 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: runUuid in: path description: UUID of the referenced run required: true schema: type: string format: uuid /api/v1/pipelines/{uuid}/runs/{runUuid}/pause: description: Suspend an in-flight pipeline run post: tags: - pipelines summary: Suspend an in-flight pipeline run description: Suspend an in-flight pipeline run operationId: postPipelinesByUuidRunsByRunUuidPause responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: runUuid in: path description: UUID of the referenced run required: true schema: type: string format: uuid /api/v1/pipelines/{uuid}/runs/{runUuid}/resume: description: Resume a suspended pipeline run post: tags: - pipelines summary: Resume a suspended pipeline run description: Resume a suspended pipeline run operationId: postPipelinesByUuidRunsByRunUuidResume responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: runUuid in: path description: UUID of the referenced run required: true schema: type: string format: uuid /api/v1/pipelines/{uuid}/versions: description: Load a paged list of pipeline versions get: tags: - pipelines summary: Load a paged list of pipeline versions description: Load a paged list of pipeline versions operationId: getPipelinesByUuidVersions parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The pipeline version list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef versionUuid: 018de784-68d3-42d7-b812-da187c3be317 versionNumber: 2 name: my-pipeline description: A sample pipeline definition: nodes: [] enabled: true priority: 10 dryRun: false - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef versionUuid: 68e9286c-644c-4192-99e7-ce6be0160487 versionNumber: 2 name: my-pipeline description: A sample pipeline definition: nodes: [] enabled: true priority: 10 dryRun: false _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/pipelines/{uuid}/versions/{version}: description: Load a specific pipeline version get: tags: - pipelines summary: Load a specific pipeline version description: Load a specific pipeline version operationId: getPipelinesByUuidVersionsByVersion responses: "200": description: The pipeline version response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef versionUuid: e571436e-4b2b-4879-a29c-502751e8bba1 versionNumber: 2 name: my-pipeline description: A sample pipeline definition: nodes: [] enabled: true priority: 10 dryRun: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: version in: path description: Sequential pipeline version number required: true schema: type: integer format: int32 /api/v1/pipelines/{uuid}/versions/{version}/restore: description: Restore a pipeline version post: tags: - pipelines summary: Restore a pipeline version description: Restore a pipeline version operationId: postPipelinesByUuidVersionsByVersionRestore requestBody: content: application/json: example: name: restored-pipeline description: Restored from version 1 responses: "201": description: The pipeline version restore response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef versionUuid: 5c8186ee-f488-4223-90eb-bb0fe17e93ba versionNumber: 2 name: restored-pipeline description: Restored from version 1 definition: nodes: [] enabled: true priority: 10 dryRun: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: version in: path description: Sequential pipeline version number required: true schema: type: integer format: int32 /api/v1/pipelines/runs/stats: description: Load aggregated daily pipeline run statistics across all pipelines get: tags: - pipelines summary: Load aggregated daily pipeline run statistics across all pipelines description: Load aggregated daily pipeline run statistics across all pipelines operationId: getPipelinesRunsStats responses: "200": description: The pipeline run stats response content: application/json: example: daily: - date: 2026-07-21 runCount: 4 successCount: 120 failureCount: 3 skippedCount: 7 - date: 2026-07-22 runCount: 2 successCount: 58 failureCount: 0 skippedCount: 1 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/pools: description: Create a new asset pool get: tags: - pools summary: Load a paged list of asset pools description: Load a paged list of asset pools operationId: getPools parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The asset pool list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: primary-storage fsPath: /tank/loom/binaries - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: primary-storage fsPath: /tank/loom/binaries _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - pools summary: Create a new asset pool description: Create a new asset pool operationId: postPools requestBody: content: application/json: example: name: primary-storage fsPath: /tank/loom/binaries responses: "200": description: The asset pool response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: primary-storage fsPath: /tank/loom/binaries "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/pools/{uuid}: description: Update an asset pool get: tags: - pools summary: Load an asset pool description: Load an asset pool operationId: getPoolsByUuid responses: "200": description: The asset pool response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: primary-storage fsPath: /tank/loom/binaries "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - pools summary: Update an asset pool description: Update an asset pool operationId: postPoolsByUuid requestBody: content: application/json: example: name: updated-storage responses: "200": description: The asset pool response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: primary-storage fsPath: /tank/loom/binaries "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - pools summary: Delete an asset pool description: Delete an asset pool operationId: deletePoolsByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/processors: description: Load a list of registered processor nodes get: tags: - processors summary: Load a list of registered processor nodes description: Load a list of registered processor nodes operationId: getProcessors parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The processor list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc name: cortex-node-1 priority: 10 host: 10.0.1.10:9090 state: ONLINE capabilities: - IO - CPU systemStatus: cpuLoad: 45.2 memoryUsed: 4294967296 memoryTotal: 17179869184 gpuLoad: 78.0 ioLoad: 31.0 diskUsed: 107374182400 diskTotal: 536870912000 lastSeen: 1.775385E9 _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/processors/{uuid}: description: Load a registered processor node get: tags: - processors summary: Load a registered processor node description: Load a registered processor node operationId: getProcessorsByUuid responses: "200": description: The processor response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc name: cortex-node-1 priority: 10 host: 10.0.1.10:9090 state: ONLINE capabilities: - IO - CPU systemStatus: cpuLoad: 45.2 memoryUsed: 4294967296 memoryTotal: 17179869184 gpuLoad: 78.0 ioLoad: 31.0 diskUsed: 107374182400 diskTotal: 536870912000 lastSeen: 1.775385E9 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - processors summary: Forget a persisted cortex instance. Only permitted while the worker is offline. description: Forget a persisted cortex instance. Only permitted while the worker is offline. operationId: deleteProcessorsByUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/processors/{uuid}/restrictions: description: Update the node-kind restrictions (whitelist/blacklist) of a cortex instance put: tags: - processors summary: Update the node-kind restrictions (whitelist/blacklist) of a cortex instance description: Update the node-kind restrictions (whitelist/blacklist) of a cortex instance operationId: putProcessorsByUuidRestrictions responses: "200": description: The processor response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc name: cortex-node-1 priority: 10 host: 10.0.1.10:9090 state: ONLINE capabilities: - IO - CPU systemStatus: cpuLoad: 45.2 memoryUsed: 4294967296 memoryTotal: 17179869184 gpuLoad: 78.0 ioLoad: 31.0 diskUsed: 107374182400 diskTotal: 536870912000 lastSeen: 1.775385E9 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/reactions: description: Load a paged list of reactions get: tags: - reactions summary: Load a paged list of reactions description: Load a paged list of reactions operationId: getReactions parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/reactions/{uuid}: description: Load a reaction get: tags: - reactions summary: Load a reaction description: Load a reaction operationId: getReactionsByUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - reactions summary: Delete a reaction description: Delete a reaction operationId: deleteReactionsByUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/reactions/assets/{assetUuid}: description: Create a new reaction on an asset get: tags: - reactions summary: List reactions on an asset description: List reactions on an asset operationId: getReactionsAssetsByAssetUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - reactions summary: Create a new reaction on an asset description: Create a new reaction on an asset operationId: postReactionsAssetsByAssetUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: assetUuid in: path description: UUID of the referenced asset required: true schema: type: string format: uuid /api/v1/roles: description: Create new role get: tags: - roles summary: Load a paged list of roles description: Load a paged list of roles operationId: getRoles parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The role list response content: application/json: example: data: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: GuestPermissions permissions: - CREATE_USER - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: GuestPermissions permissions: - CREATE_USER _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - roles summary: Create new role description: Create new role operationId: postRoles requestBody: content: application/json: example: name: GuestPermissions meta: abc: cdef permissions: - CREATE_USER responses: "200": description: The role response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: GuestPermissions permissions: - CREATE_USER "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/roles/{uuid}: description: Update a role get: tags: - roles summary: Load a role description: Load a role operationId: getRolesByUuid responses: "200": description: The role response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: GuestPermissions permissions: - CREATE_USER "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - roles summary: Update a role description: Update a role operationId: postRolesByUuid requestBody: content: application/json: example: name: new_role_name meta: abc: cdef permissions: - CREATE_USER responses: "200": description: The role response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: GuestPermissions permissions: - CREATE_USER "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - roles summary: Delete a role description: Delete a role operationId: deleteRolesByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/sessions/{uuid}/download: description: Download a file from the chat's live coding-session workspace get: tags: - sessions summary: Download a file from the chat's live coding-session workspace description: Download a file from the chat's live coding-session workspace operationId: getSessionsByUuidDownload responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/sessions/{uuid}/files: description: List a directory of the chat's live coding-session workspace get: tags: - sessions summary: List a directory of the chat's live coding-session workspace description: List a directory of the chat's live coding-session workspace operationId: getSessionsByUuidFiles responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/sessions/{uuid}/preview: description: Sandboxed inline preview of a file from the chat's live coding-session workspace get: tags: - sessions summary: Sandboxed inline preview of a file from the chat's live coding-session workspace description: Sandboxed inline preview of a file from the chat's live coding-session workspace operationId: getSessionsByUuidPreview responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/skills: description: Create a new skill get: tags: - skills summary: Load a paged list of the callers own skills description: Load a paged list of the callers own skills operationId: getSkills parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The skill list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: transcript-summarizer description: Summarize video transcripts into concise bullet lists content: |- # Transcript Summarizer Summarize the transcript of the referenced asset into short bullet points. enabled: true published: false - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: transcript-summarizer description: Summarize video transcripts into concise bullet lists content: |- # Transcript Summarizer Summarize the transcript of the referenced asset into short bullet points. enabled: true published: false _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - skills summary: Create a new skill description: Create a new skill operationId: postSkills requestBody: content: application/json: example: meta: abc: cdef name: transcript-summarizer description: Summarize video transcripts into concise bullet lists content: |- # Transcript Summarizer Summarize the transcript of the referenced asset into short bullet points. responses: "200": description: The skill response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: transcript-summarizer description: Summarize video transcripts into concise bullet lists content: |- # Transcript Summarizer Summarize the transcript of the referenced asset into short bullet points. enabled: true published: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/skills/{uuid}: description: Update a skill get: tags: - skills summary: Load a skill description: Load a skill operationId: getSkillsByUuid responses: "200": description: The skill response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: transcript-summarizer description: Summarize video transcripts into concise bullet lists content: |- # Transcript Summarizer Summarize the transcript of the referenced asset into short bullet points. enabled: true published: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - skills summary: Update a skill description: Update a skill operationId: postSkillsByUuid requestBody: content: application/json: example: meta: abc: cdef name: transcript-summarizer description: Updated description content: |- # Transcript Summarizer Updated instructions. enabled: false published: true responses: "200": description: The skill response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: transcript-summarizer description: Summarize video transcripts into concise bullet lists content: |- # Transcript Summarizer Summarize the transcript of the referenced asset into short bullet points. enabled: true published: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - skills summary: Delete a skill description: Delete a skill operationId: deleteSkillsByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/skills/{uuid}/install: description: Install a published skill by copying it into the callers own skill set post: tags: - skills summary: Install a published skill by copying it into the callers own skill set description: Install a published skill by copying it into the callers own skill set operationId: postSkillsByUuidInstall responses: "200": description: The skill response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: transcript-summarizer description: Summarize video transcripts into concise bullet lists content: |- # Transcript Summarizer Summarize the transcript of the referenced asset into short bullet points. enabled: true published: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/skills/{uuid}/versions: description: Load a paged list of a skills versions get: tags: - skills summary: Load a paged list of a skills versions description: Load a paged list of a skills versions operationId: getSkillsByUuidVersions parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The skill version list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: transcript-summarizer description: Summarize video transcripts into concise bullet lists content: |- # Transcript Summarizer Summarize the transcript of the referenced asset into short bullet points. enabled: true published: false versionUuid: 86abc160-4da2-4951-a91f-da0c33fbc634 versionNumber: 1 - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: transcript-summarizer description: Summarize video transcripts into concise bullet lists content: |- # Transcript Summarizer Summarize the transcript of the referenced asset into short bullet points. enabled: true published: false versionUuid: 86abc160-4da2-4951-a91f-da0c33fbc634 versionNumber: 1 _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/skills/{uuid}/versions/{version}: description: Load a specific skill version get: tags: - skills summary: Load a specific skill version description: Load a specific skill version operationId: getSkillsByUuidVersionsByVersion responses: "200": description: The skill response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: transcript-summarizer description: Summarize video transcripts into concise bullet lists content: |- # Transcript Summarizer Summarize the transcript of the referenced asset into short bullet points. enabled: true published: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: version in: path description: Sequential pipeline version number required: true schema: type: integer format: int32 /api/v1/skills/{uuid}/versions/{version}/restore: description: "Revert a skill to a specific version, deleting all newer versions" post: tags: - skills summary: "Revert a skill to a specific version, deleting all newer versions" description: "Revert a skill to a specific version, deleting all newer versions" operationId: postSkillsByUuidVersionsByVersionRestore responses: "200": description: The skill response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: transcript-summarizer description: Summarize video transcripts into concise bullet lists content: |- # Transcript Summarizer Summarize the transcript of the referenced asset into short bullet points. enabled: true published: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid - name: version in: path description: Sequential pipeline version number required: true schema: type: integer format: int32 /api/v1/skills/library: description: Load a paged list of published skills from all users (the shared skill library) get: tags: - skills summary: Load a paged list of published skills from all users (the shared skill library) description: Load a paged list of published skills from all users (the shared skill library) operationId: getSkillsLibrary parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The skill list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: transcript-summarizer description: Summarize video transcripts into concise bullet lists content: |- # Transcript Summarizer Summarize the transcript of the referenced asset into short bullet points. enabled: true published: false - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: transcript-summarizer description: Summarize video transcripts into concise bullet lists content: |- # Transcript Summarizer Summarize the transcript of the referenced asset into short bullet points. enabled: true published: false _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/spaces: description: Create a new space get: tags: - spaces summary: Load a paged list of spaces description: Load a paged list of spaces operationId: getSpaces parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The space list response content: application/json: example: data: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: The Space Name - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: The Space Name _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - spaces summary: Create a new space description: Create a new space operationId: postSpaces requestBody: content: application/json: example: meta: abc: cdef name: The Space Name responses: "200": description: The space response content: application/json: example: uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: The Space Name "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/spaces/{uuid}: description: Update a space get: tags: - spaces summary: Load a space description: Load a space operationId: getSpacesByUuid responses: "200": description: The space response content: application/json: example: uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: The Space Name "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - spaces summary: Update a space description: Update a space operationId: postSpacesByUuid requestBody: content: application/json: example: meta: abc: cdef name: The new name responses: "200": description: The space response content: application/json: example: uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: The Space Name "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - spaces summary: Delete a space description: Delete a space operationId: deleteSpacesByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/tags: description: Create new tag get: tags: - tags summary: Load a paged list of tags description: Load a paged list of tags operationId: getTags parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The tag list response content: application/json: example: data: - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: red area: from: 12 to: 42 width: 480 height: 200 startX: 120 startY: 240 color: 1681de collection: colors - uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: red area: from: 12 to: 42 width: 480 height: 200 startX: 120 startY: 240 color: 1681de collection: colors _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - tags summary: Create new tag description: Create new tag operationId: postTags requestBody: content: application/json: example: name: red collection: colors meta: abc: cdef responses: "200": description: The tag response content: application/json: example: uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: red area: from: 12 to: 42 width: 480 height: 200 startX: 120 startY: 240 color: 1681de collection: colors "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/tags/{uuid}: description: Update a tag get: tags: - tags summary: Load a tag description: Load a tag operationId: getTagsByUuid responses: "200": description: The tag response content: application/json: example: uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: red area: from: 12 to: 42 width: 480 height: 200 startX: 120 startY: 240 color: 1681de collection: colors "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - tags summary: Update a tag description: Update a tag operationId: postTagsByUuid requestBody: content: application/json: example: name: red collection: colors meta: abc: cdef responses: "200": description: The tag response content: application/json: example: uuid: 86abc160-4da2-4951-a91f-da0c33fbc634 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef name: red area: from: 12 to: 42 width: 480 height: 200 startX: 120 startY: 240 color: 1681de collection: colors "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - tags summary: Delete a tag description: Delete a tag operationId: deleteTagsByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/tags/{uuid}/rating: description: Set the current user's rating for a tag get: tags: - tags summary: Load the current user's rating for a tag description: Load the current user's rating for a tag operationId: getTagsByUuidRating responses: "200": description: The tag rating response content: application/json: example: rating: 7 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - tags summary: Set the current user's rating for a tag description: Set the current user's rating for a tag operationId: postTagsByUuidRating requestBody: content: application/json: example: rating: 7 responses: "200": description: The tag rating response content: application/json: example: rating: 7 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - tags summary: Remove the current user's rating for a tag description: Remove the current user's rating for a tag operationId: deleteTagsByUuidRating responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/tasks: description: Create new task get: tags: - tasks summary: Load a paged list of tasks description: Load a paged list of tasks operationId: getTasks parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The task list response content: application/json: example: data: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} meta: abc: cdef title: The title priority: MEDIUM taskStatus: PENDING dueDate: 2026-08-01T12:00:00Z comments: [] _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - tasks summary: Create new task description: Create new task operationId: postTasks requestBody: content: application/json: example: meta: abc: cdef title: The title priority: MEDIUM taskStatus: PENDING dueDate: 2026-08-01T12:00:00Z responses: "200": description: The task response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} meta: abc: cdef title: The title priority: MEDIUM taskStatus: PENDING dueDate: 2026-08-01T12:00:00Z comments: [] "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/tasks/{taskUuid}/comments: description: Create a new comment on a task get: tags: - tasks summary: List the comments on a task description: List the comments on a task operationId: getTasksByTaskUuidComments responses: "200": description: The comment list response content: application/json: example: data: - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: The Title text: The comment text - uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: The Title text: The comment text _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - tasks summary: Create a new comment on a task description: Create a new comment on a task operationId: postTasksByTaskUuidComments requestBody: content: application/json: example: meta: abc: cdef title: The comment title text: The comment text responses: "200": description: The comment response content: application/json: example: uuid: 0f3332a6-e404-4777-88a9-1fa984a311bc status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef title: The Title text: The comment text "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: taskUuid in: path description: UUID of the referenced task required: true schema: type: string format: uuid /api/v1/tasks/{taskUuid}/reactions: description: Create a new reaction for a task get: tags: - tasks summary: Load a paged list of reactions for a task description: Load a paged list of reactions for a task operationId: getTasksByTaskUuidReactions responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - tasks summary: Create a new reaction for a task description: Create a new reaction for a task operationId: postTasksByTaskUuidReactions responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: taskUuid in: path description: UUID of the referenced task required: true schema: type: string format: uuid /api/v1/tasks/{taskUuid}/reactions/{reactionUuid}: description: Delete a reaction for a task get: tags: - tasks summary: Return a specific reaction for a task description: Return a specific reaction for a task operationId: getTasksByTaskUuidReactionsByReactionUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - tasks summary: Update a reaction for a task description: Update a reaction for a task operationId: postTasksByTaskUuidReactionsByReactionUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - tasks summary: Delete a reaction for a task description: Delete a reaction for a task operationId: deleteTasksByTaskUuidReactionsByReactionUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: taskUuid in: path description: UUID of the referenced task required: true schema: type: string format: uuid - name: reactionUuid in: path description: UUID of the referenced reaction required: true schema: type: string format: uuid /api/v1/tasks/{uuid}: description: Update a task get: tags: - tasks summary: Load a task description: Load a task operationId: getTasksByUuid responses: "200": description: The task response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} meta: abc: cdef title: The title priority: MEDIUM taskStatus: PENDING dueDate: 2026-08-01T12:00:00Z comments: [] "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - tasks summary: Update a task description: Update a task operationId: postTasksByUuid requestBody: content: application/json: example: meta: abc: cdef title: The title priority: HIGH taskStatus: REVIEW dueDate: 2026-08-01T12:00:00Z responses: "200": description: The task response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: {} meta: abc: cdef title: The title priority: MEDIUM taskStatus: PENDING dueDate: 2026-08-01T12:00:00Z comments: [] "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - tasks summary: Delete a task description: Delete a task operationId: deleteTasksByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/tokens: description: Create a new API token get: tags: - tokens summary: Load a paged list of tokens description: Load a paged list of tokens operationId: getTokens parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - tokens summary: Create a new API token description: Create a new API token operationId: postTokens responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/tokens/{uuid}: description: Update a token get: tags: - tokens summary: Load a token description: Load a token operationId: getTokensByUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - tokens summary: Update a token description: Update a token operationId: postTokensByUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - tokens summary: Delete a token description: Delete a token operationId: deleteTokensByUuid responses: "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid /api/v1/users: description: Create new user get: tags: - users summary: Load a paged list of users description: Load a paged list of users operationId: getUsers parameters: - name: filter in: query description: Filter the elements schema: type: string example: "name[eq]=joedoe" - name: limit in: query description: Limit the page size schema: type: string example: "25" - name: from in: query description: Seek to the element with the given UUID schema: type: string example: e829f0f1-4775-4857-a326-850440cf9577 - name: sort in: query description: Sort the elements by the provided field schema: type: string example: username - name: dir in: query description: Sort order direction schema: type: string example: ASCENDING responses: "200": description: The user list response content: application/json: example: data: - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef username: joedoe firstname: Joe lastname: Doe email: joedoe@metaloom.io enabled: false - uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef username: joedoe firstname: Joe lastname: Doe email: joedoe@metaloom.io enabled: false _metainfo: perPage: 2 totalCount: 28 "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - users summary: Create new user description: Create new user operationId: postUsers requestBody: content: application/json: example: username: joedoe firstname: Joe lastname: Doe email: joedoe@metaloom.io meta: abc: cdef responses: "200": description: The user response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef username: joedoe firstname: Joe lastname: Doe email: joedoe@metaloom.io enabled: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" /api/v1/users/{uuid}: description: Update a user get: tags: - users summary: Load a user description: Load a user operationId: getUsersByUuid responses: "200": description: The user response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef username: joedoe firstname: Joe lastname: Doe email: joedoe@metaloom.io enabled: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" put: tags: - users summary: Replace a user. All replaceable fields must be present in the request body. description: Replace a user. All replaceable fields must be present in the request body. operationId: putUsersByUuid requestBody: content: application/json: example: meta: abc: cdef username: joedoe firstname: Joe lastname: Doe email: joedoe@metaloom.io responses: "200": description: The user response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef username: joedoe firstname: Joe lastname: Doe email: joedoe@metaloom.io enabled: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" post: tags: - users summary: Update a user description: Update a user operationId: postUsersByUuid requestBody: content: application/json: example: meta: abc: cdef username: joedoe firstname: Joe lastname: Doe email: joedoe@metaloom.io responses: "200": description: The user response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef username: joedoe firstname: Joe lastname: Doe email: joedoe@metaloom.io enabled: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" delete: tags: - users summary: Delete a user description: Delete a user operationId: deleteUsersByUuid responses: "204": description: The delete response "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" patch: tags: - users summary: Partially update a user. Only the fields present in the request body are modified. description: Partially update a user. Only the fields present in the request body are modified. operationId: patchUsersByUuid requestBody: content: application/json: example: meta: abc: cdef username: joedoe firstname: Joe lastname: Doe email: joedoe@metaloom.io responses: "200": description: The user response content: application/json: example: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 status: creator: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe created: 2018-10-12T14:15:06Z editor: uuid: f04e89d0-076d-4d90-b192-715a25a2cd59 name: joedoe edited: 2018-11-20T20:12:01Z meta: abc: cdef username: joedoe firstname: Joe lastname: Doe email: joedoe@metaloom.io enabled: false "400": description: Bad request - validation error or malformed path/query parameter content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "401": description: "Unauthorized - the token is missing, expired or invalid" content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "403": description: Forbidden - the user lacks the required permission content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "404": description: Not found - no such resource content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/GenericMessageResponse" parameters: - name: uuid in: path description: UUID of the resource required: true schema: type: string format: uuid components: schemas: GenericMessageResponse: type: object properties: message: type: string description: Human readable message description: Error and status message envelope. securitySchemes: bearerAuth: type: http description: JWT from `POST /api/v1/login` or an API token from `/api/v1/tokens`. scheme: bearer bearerFormat: JWT cookieAuth: type: apiKey description: HttpOnly session cookie set by the login and OAuth2 callback routes. name: __Host-loom_token in: cookie