{"info":{"_postman_id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","name":"TakeOne Public API","description":"

Overview

The TakeOne API provides an end-to-end solution for professional profile videos. We support the entire video creation life cycle, from guiding the user in creating the video to hosting and streaming the video on the user profile page.

Our solution includes REST API, HTML video player, a recording app, and a web management tool to give our customers everything they need to integrate high-quality, better converting profile videos into their platform.

This documentation covers all the endpoints required to implement the API integration.

Base url: https://api.takeone.video

Definitions:

App User - The App User represents your user in the TakeOne system. This user is required to perform various actions regarding creating and managing a video for a provider.
\n
Project - the object representing all the state and data required for a video recording. Once the project is completed, that project will have a streamable link associated with the video.
\n
Container - In this context, a \"container\" is an object that serves as the central entity responsible for managing various videos and projects for a specific use case. It can be likened to a \"billboard\" where content is displayed. The container is in charge of handling all aspects of the project life cycle, including video states, determining which video is ready for publication, and managing the creation of new videos tailored to particular locations, users, and types.
\n
Container template (type) - each container has a set of characteristics that define its properties, which will eventually determine the type of videos created for that container such that all videos are from the same type. For example, a company can create a profile template with horizontal videos, and the user can record as many videos for that container. At this point, the template creation is being done on our side and is part of the pre-configuration of the integration.
\n

Webhooks:

If configured, notifications will be send to the webhook URL in the following circumstances:

A project status changes (project_status_change).
\n
Project publishing has completed (project_published). Project publishing is initiated either via the app user electing to publish the video, or via the Publish Project API endpoint.
\n
Project unpublishing has completed (project_unpublished). Project unpublishing is initiated via the Unpublish Project endoint.
\n

Each webhook notification will include a notification type, a timestamp, a summary of the project, and a summary its video container.

{\n    \"type\": \"project_published\", // one of ('project_status_change', 'project_published', 'project_unpublished')\n    \"timestamp\": 1714493662,\n    \"project\": {\n        \"id\": \"694be4b1-ef0b-4a73-8b39-bba8915fa13f\",\n        \"video_container\": \"7fd3964f-9f4b-49f4-a2d7-74c2927498b7\",\n        \"user\": \"2a55b35f-612c-4bed-9409-1f0350e1a9d0\",\n        \"state\": \"completed\",\n        \"publishing_status\": \"published\",\n        \"language\": \"en\",\n        \"created_date_time\": \"2024-04-26T22:16:41.432197Z\",\n        \"modified_date_time\": \"2024-04-30T16:10:59.412675Z\",\n        \"published_video_stream\": { // deprecated\n            \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n            \"type\": \"application/x-mpegURL\",\n            \"video_format\": \"landscape\",\n            \"preview_images\": {\n                \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n            }\n        },\n        \"publishing_info\": { // either null or a map containing the published video information keyed by processed video format\n            \"portrait\": {\n                \"video\": {\n                    \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n                    \"type\": \"application/x-mpegURL\"\n                },\n                \"images\": {\n                    \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                    \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                    \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n                }\n            },\n            \"landscape\": {\n                \"video\": {\n                    \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n                    \"type\": \"application/x-mpegURL\"\n                },\n                \"images\": {\n                    \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                    \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                    \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n                }\n            }\n        }\n    },\n    \"video_container\": {\n        \"id\": \"7fd3964f-9f4b-49f4-a2d7-74c2927498b7\",\n        \"template\": \"3c0a6647-d7a8-4859-88aa-85d36f21da23\",\n        \"hotlinking_protection_enabled\": false,\n        \"allowed_origins\": [],\n        \"language\": \"en\",\n        \"created_date_time\": \"2024-04-26T22:16:41.127624Z\",\n        \"modified_date_time\": \"2024-04-26T22:16:41.127644Z\",\n        \"video_stream\": { // deprecated\n            \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n            \"type\": \"application/x-mpegURL\",\n            \"video_format\": \"landscape\",\n            \"preview_images\": {\n                \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n            }\n        },\n        \"publishing_info\": { // either null or a map containing the published video information keyed by processed video format\n            \"portrait\": {\n                \"video\": {\n                    \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n                    \"type\": \"application/x-mpegURL\"\n                },\n                \"images\": {\n                    \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                    \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                    \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n                }\n            },\n            \"landscape\": {\n                \"video\": {\n                    \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n                    \"type\": \"application/x-mpegURL\"\n                },\n                \"images\": {\n                    \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                    \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                    \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n                }\n            }\n        }\n    }\n}\n\n

Note - Currently, the webhooks are only configurable via direct communication with our engineering support team. If you have any questions, please write to us at info@takeone.video.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"27705263","collectionId":"fde91e9f-a6c9-4143-9c69-fea3db5191be","publishedId":"2s93sW9vkp","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-06-04T18:23:06.000Z"},"item":[{"name":"App Users","item":[{"name":"Create App User","id":"6788d9a3-fa37-49a0-9de7-002325a40308","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"given_name\": \"John\",\n \"family_name\": \"Doe\",\n \"email_address\": \"johndoe@example.com\",\n \"external_id\": \"0123456789\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/app_users","description":"

Create App User API Endpoint

This API endpoint allows you to create a user in our system, which represents a client user and is necessary for managing video projects.

Endpoint

POST /api/v1/app_users

Request Body

The request body should be a JSON object with the following structure:

{\n    \"given_name\": \"John\",\n    \"family_name\": \"Doe\",\n    \"email_address\": \"johndoe@example.com\",\n    \"external_id\": \"0123456789\"\n}\n\n

external_id (optional): A unique identifier for the user in your system. It will be associated with the created user in our system.
\n
given_name (optional): The user's first name.
\n
family_name (optional): The user's last name.
\n
email_address (optional): An email address associated with the user. This is helpful if you leverage the customer portal or would like TakeOne to send emails on your behalf.
\n

Example Response

Upon successful creation of the app user, the API will respond with a JSON object representing the created user. The response will have the following structure:

{\n    \"id\": \"7455aece-9acc-44e6-8df5-907bf6342b28\",\n    \"is_active\": true,\n    \"external_id\": \"0123456789\",\n    \"display_name\": null,\n    \"given_name\": \"John\",\n    \"family_name\": \"Doe\",\n    \"email_address\": \"johndoe@example.com\",\n    \"projects\": [],\n    \"status\": {\n        \"state\": \"not_invited\",\n        \"date_time\": \"2025-07-25T20:50:22.459687Z\"\n    },\n    \"created_date_time\": \"2025-07-25T20:50:22.459687Z\",\n    \"modified_date_time\": \"2025-07-25T20:50:22.459703Z\"\n}\n\n

id: The unique identifier assigned to the created app user in our system.
\n
is_active: A boolean indicating whether the user is active or not.
\n
external_id: The external_id provided in the request.
\n
given_name: The first name of the user (optional).
\n
family_name: The last name of the user (optional).
\n
email_address: The email address of the user (optional).
\n
projects: An array of projects associated with the user (optional).
\n
status: The state field may be not_invited, pending (an invitation link has been generated but they have not logged in to the app), active (they've logged in), or inactive
\n
created_date_time: The date and time when the app user was created in our system.
\n
modified_date_time: The date and time when the app user was last modified in our system.
\n

Please note that the given_name, family_name, and email_address fields may be updated or populated with additional information as per your requirements.

Status Codes

201 Created: The app user was successfully created.
\n
400 Bad Request: If the request body is missing or the external_id parameter is invalid.
\n
500 Internal Server Error: If there was an error processing the request on the server side.
\n

\n","urlObject":{"path":["api","v1","app_users"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6788d9a3-fa37-49a0-9de7-002325a40308"},{"name":"Fetch App Users","id":"24aa68ba-ea9f-472e-a085-593bd8452493","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/api/v1/app_users","description":"

Get App Users API Endpoint

This API endpoint allows you to retrieve a list of all app users in the system.

Endpoint

GET /api/v1/app_users

Query Parameters

external_id (optional)

Description: The external identifier of the user you want to retrieve. This identifier should be unique.

Example:

/api/v1/app_users?external_id=0123456789

Example Response

The API will respond with a JSON object representing the list of app users. The response will have the following structure:

{\n    \"count\": 3,\n    \"next\": \"https://api.dev.takeone.video/api/v1/app_users\",\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"5f8c9d8e-84d6-4dc2-bf08-c1bdb28ac25f\",\n            \"is_active\": true,\n            \"external_id\": null,\n            \"display_name\": null,\n            \"given_name\": \"John\",\n            \"family_name\": \"Hartquist\",\n            \"email_address\": \"john@takeone.video\",\n            \"projects\": [\n                {\n                    \"id\": \"8274ed32-5a66-439b-b665-6a3946b898f4\",\n                    \"organization_display_name\": null,\n                    \"created_date_time\": \"2025-07-25T16:54:35.474872Z\",\n                    \"modified_date_time\": \"2025-07-25T16:57:49.567413Z\"\n                },\n                {\n                    \"id\": \"eb598099-2ba1-4ec0-a31a-9a6ca152e9aa\",\n                    \"organization_display_name\": null,\n                    \"created_date_time\": \"2025-07-25T16:54:44.944085Z\",\n                    \"modified_date_time\": \"2025-07-25T17:12:56.719243Z\"\n                }\n            ],\n            \"status\": {\n                \"state\": \"active\",\n                \"date_time\": \"2025-07-25T16:55:22.080114Z\"\n            },\n            \"created_date_time\": \"2025-07-25T16:54:31.277059Z\",\n            \"modified_date_time\": \"2025-07-25T16:54:31.277076Z\"\n        },\n        {\n            \"id\": \"d4e48dae-bfd8-4d49-88ff-1cb96751dccc\",\n            \"is_active\": true,\n            \"external_id\": null,\n            \"display_name\": null,\n            \"given_name\": \"Daniel\",\n            \"family_name\": \"Sorochkin\",\n            \"email_address\": \"daniel@takeone.video\",\n            \"projects\": [\n                {\n                    \"id\": \"e6e9de6f-bca3-4e31-8460-1a7f086b2ad2\",\n                    \"organization_display_name\": null,\n                    \"created_date_time\": \"2025-07-22T02:38:16.382991Z\",\n                    \"modified_date_time\": \"2025-07-25T15:38:47.052518Z\"\n                },\n                {\n                    \"id\": \"5d649e1a-1216-4e57-8b6c-6817986cbd5d\",\n                    \"organization_display_name\": null,\n                    \"created_date_time\": \"2025-07-22T02:38:10.309959Z\",\n                    \"modified_date_time\": \"2025-07-25T15:39:05.792213Z\"\n                }\n            ],\n            \"status\": {\n                \"state\": \"active\",\n                \"date_time\": \"2025-07-22T04:06:29.305214Z\"\n            },\n            \"created_date_time\": \"2025-07-22T02:38:05.886524Z\",\n            \"modified_date_time\": \"2025-07-22T02:38:05.886541Z\"\n        },\n        ...\n    ],\n}\n\n

next: The URL of the next page of results (currently null, indicating no more pages).
\n
previous: The URL of the previous page of results (currently null, indicating the first page).
\n
results: An array containing the app users retrieved from the system. Each user object has the following attributes:
\n
- id: The unique identifier of the app user.
  \n
- is_active: A boolean indicating whether the user is active or not.
  \n
- external_id: The external identifier associated with the user.
  \n
- given_name: The display name of the user.
  \n
- family_name: The display name of the user.
  \n
- email_address: The email address of the user.
  \n
- projects: An array of projects associated with the user. Each project object within the array has the following attributes:
  \n
  - id: The unique identifier of the project.
    \n
  - organization_display_name: The display name of the organization associated with the project.
    \n
  - created_date_time: The date and time when the project was created.
    \n
  - modified_date_time: The date and time when the project was last modified.
    \n
  \n
- created_date_time: The date and time when the user was created in the system.
  \n
- modified_date_time: The date and time when the user was last modified in the system.
  \n
\n

Please note that the external_id, email_address, and organization_display_name fields may be null or contain values based on the user and project settings.

Status Codes

200 OK: The request was successful, and the app users list is returned.
\n
500 Internal Server Error: If there was an error processing the request on the server side.
\n

\n","urlObject":{"path":["api","v1","app_users"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"24aa68ba-ea9f-472e-a085-593bd8452493"},{"name":"Fetch App User","id":"b90d1646-5275-44b4-b1a7-a742988a6c5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/api/v1/app_users/{{user_id}}","description":"

Get App User API Endpoint

This API endpoint allows you to retrieve a user by TakeOne ID.

Endpoint

GET /api/v1/app_users/{id}

Example Response

The API will respond with a JSON object representing the list of app users. The response will have the following structure:

{\n    \"id\": \"5f8c9d8e-84d6-4dc2-bf08-c1bdb28ac25f\",\n    \"is_active\": true,\n    \"external_id\": null,\n    \"display_name\": null,\n    \"given_name\": \"John\",\n    \"family_name\": \"Hartquist\",\n    \"email_address\": \"john@takeone.video\",\n    \"projects\": [\n        {\n            \"id\": \"8274ed32-5a66-439b-b665-6a3946b898f4\",\n            \"organization_display_name\": null,\n            \"created_date_time\": \"2025-07-25T16:54:35.474872Z\",\n            \"modified_date_time\": \"2025-07-25T16:57:49.567413Z\"\n        },\n        {\n            \"id\": \"eb598099-2ba1-4ec0-a31a-9a6ca152e9aa\",\n            \"organization_display_name\": null,\n            \"created_date_time\": \"2025-07-25T16:54:44.944085Z\",\n            \"modified_date_time\": \"2025-07-25T17:12:56.719243Z\"\n        }\n    ],\n    \"status\": {\n        \"state\": \"active\",\n        \"date_time\": \"2025-07-25T16:55:22.080114Z\"\n    },\n    \"created_date_time\": \"2025-07-25T16:54:31.277059Z\",\n    \"modified_date_time\": \"2025-07-25T16:54:31.277076Z\"\n}\n\n

next: The URL of the next page of results (currently null, indicating no more pages).
\n
previous: The URL of the previous page of results (currently null, indicating the first page).
\n
results: An array containing the app users retrieved from the system. Each user object has the following attributes:
\n
- id: The unique identifier of the app user.
  \n
- is_active: A boolean indicating whether the user is active or not.
  \n
- external_id: The external identifier associated with the user.
  \n
- given_name: The display name of the user.
  \n
- family_name: The display name of the user.
  \n
- email_address: The email address of the user.
  \n
- projects: An array of projects associated with the user. Each project object within the array has the following attributes:
  \n
  - id: The unique identifier of the project.
    \n
  - organization_display_name: The display name of the organization associated with the project.
    \n
  - created_date_time: The date and time when the project was created.
    \n
  - modified_date_time: The date and time when the project was last modified.
    \n
  \n
- created_date_time: The date and time when the user was created in the system.
  \n
- modified_date_time: The date and time when the user was last modified in the system.
  \n
\n

Please note that the external_id, email_address, and organization_display_name fields may be null or contain values based on the user and project settings.

Status Codes

200 OK: The request was successful, and the app users list is returned.
\n
500 Internal Server Error: If there was an error processing the request on the server side.
\n

\n","urlObject":{"path":["api","v1","app_users","{{user_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b90d1646-5275-44b4-b1a7-a742988a6c5f"},{"name":"Update App User","id":"fb33d6b0-5a98-4890-bf93-6878459dbd47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"external_id\": \"9876543210\",\n \"given_name\": \"Jack\",\n \"family_name\": \"Doe\",\n \"email_address\": \"jackdoe@example.com\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/app_users/7455aece-9acc-44e6-8df5-907bf6342b28","description":"

Update App User API Endpoint

This API endpoint allows you to update a user object with optional fields.

Endpoint

PUT /api/v1/app_users/{id}

Request Body

The request body should be a JSON object with the following structure:

{\n    \"external_id\": \"9876543210\",\n    \"given_name\": \"Jack\",\n    \"family_name\": \"Doe\",\n    \"email_address\": \"jackdoe@example.com\"\n}\n\n

external_id (optional): A unique identifier for the user in your system. It will be associated with the created user in our system.
\n
display_name (optional): A display name that you would like to give to the user. This is helpful if you leverage the customer portal.
\n
email_address (optional): An email address associated with the user. This is helpful if you leverage the customer portal or would like TakeOne to send emails on your behalf.
\n

Example Response

Upon successful update of the user, the API will respond with a JSON object representing the updated user:

{\n    \"id\": \"7455aece-9acc-44e6-8df5-907bf6342b28\",\n    \"is_active\": true,\n    \"external_id\": \"9876543210\",\n    \"display_name\": null,\n    \"given_name\": \"Jack\",\n    \"family_name\": \"Doe\",\n    \"email_address\": \"jackdoe@example.com\",\n    \"projects\": [],\n    \"status\": {\n        \"state\": \"not_invited\",\n        \"date_time\": \"2025-07-25T20:50:22.459687Z\"\n    },\n    \"created_date_time\": \"2025-07-25T20:50:22.459687Z\",\n    \"modified_date_time\": \"2025-07-25T21:01:45.110668Z\"\n}\n\n

id: The unique identifier assigned to the created app user in our system.
\n
is_active: A boolean indicating whether the user is active or not.
\n
external_id: The external_id provided in the request.
\n
given_name: The first name of the user (optional).
\n
family_name: The first name of the user (optional).
\n
email_address: The email address of the user (optional).
\n
projects: An array of projects associated with the user (optional).
\n
created_date_time: The date and time when the app user was created in our system.
\n
modified_date_time: The date and time when the app user was last modified in our system.
\n

Please note that the display_name, email_address, and projects fields may be updated or populated with additional information as per your requirements.

Status Codes

201 Created: The app user was successfully created.
\n
400 Bad Request: If the request body is missing or the external_id parameter is invalid.
\n
404 Not Found: If the specified user ID does not exist.
\n
500 Internal Server Error: If there was an error processing the request on the server side.
\n

\n","urlObject":{"path":["api","v1","app_users","7455aece-9acc-44e6-8df5-907bf6342b28"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb33d6b0-5a98-4890-bf93-6878459dbd47"},{"name":"Create User Auth Code","id":"1b1c6b89-3f63-47d6-be72-e67e7c111259","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user\": \"c7242ea3-4592-4364-9b16-795a13007120\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/app_users/authorize","description":"

Authorize User API Endpoint

This API endpoint allows you to generate an authorization code for a user.

Endpoint

POST /api/v1/app_users/authorize

Request Body

The request body should be a JSON object with the following attribute:

user: The identifier of the user for whom the authorization code is generated. This is represented as a string.

Example Request Body:

{\n    \"user\": \"c7242ea3-4s92-4364-9b16-795a13fg7120\"\n}\n\n

Example Response

Upon successful generation of the authorization code, the API will respond with a JSON object containing the authorization code:

{\n    \"code\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ.....\"\n}\n\n

code: The generated authorization code, represented as a string. This code is typically a JSON Web Token (JWT) that can be used for authentication and authorization purposes.

Status Codes

201 Created: The request was successful, and the authorization code was generated.
\n
400 Bad Request: If the request body is invalid or missing required fields.
\n
500 Internal Server Error: If there was an error processing the request on the server side.
\n

\n","urlObject":{"path":["api","v1","app_users","authorize"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1b1c6b89-3f63-47d6-be72-e67e7c111259"},{"name":"Send User Invitation Email","id":"bb21d5ca-1ed7-4222-8a23-b81607e8283c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user\": \"5f8c9d8e-84d6-4dc2-bf08-c1bdb28ac25f\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/app_users/email","description":"

Send User Invitation Email API Endpoint

This API endpoint allows you to send an invitation email to a user. The invitation email template must be configured by the TakeOne team. We recommend sending the emails on your side if at all possible, as we do not provide guarantees of delivery. We will return an error if the user does not have an email configured in the system, or if the invitation email template is not configured.

Endpoint

POST /api/v1/app_users/email

Request Body

The request body should be a JSON object with the following attribute:

user: The identifier of the user for whom the email is sent.

Example Request Body:

{\n    \"user\": \"c7242ea3-4s92-4364-9b16-795a13fg7120\"\n}\n\n

Example Response

A success response will contain an empty object and indicates that an email has been attempted to be sent. The email may be invalid and fail to be delivered. We recommend

{}\n\n

Status Codes

201 Created: The request was successful, and the email has been queued for delivery.
\n
400 Bad Request: If the request body is invalid or missing required fields.
\n
500 Internal Server Error: If there was an error processing the request on the server side.
\n

\n","urlObject":{"path":["api","v1","app_users","email"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb21d5ca-1ed7-4222-8a23-b81607e8283c"}],"id":"02c21229-fa00-4502-ab66-fe8d1611c334","_postman_id":"02c21229-fa00-4502-ab66-fe8d1611c334","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":true,"source":{"_postman_id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","name":"TakeOne Public API","type":"collection"}}},{"name":"Video Containers","item":[{"name":"Fetch Video Container Templates","id":"d3b20991-78be-4df5-8b77-2e3c088fee20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/api/v1/video_container_templates","description":"

Video Container Templates API Endpoint

This API endpoint allows you to retrieve all the video container templates available in the system.

Endpoint

GET /api/v1/video_container_templates

Request Body

This endpoint does not require a request body. The request should be sent without any additional data.

Example Response

Upon successful retrieval of the video container templates, the API will respond with a JSON object containing the templates:

{\n    \"count\": 2,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"f0531cd1-e90a-4a4c-8857-406dc5414c1d\",\n            \"container_type\": \"subscription\",\n            \"name\": \"Psychology Today Video\",\n            \"description\": \"This is a short video that can be uploaded to Psychology Today. It should be no longer than 14 seconds.\",\n            \"video_hosting_enabled\": true,\n            \"video_download_enabled\": false,\n            \"manager_review_required\": false,\n            \"video_format\": \"portrait\",\n            \"video_formats\": [\n                \"portrait\"\n            ],\n            \"recording_video_orientation\": \"portrait\",\n            \"subtitles_inclusion\": \"no\",\n            \"lower_thirds_inclusion\": \"no\",\n            \"music_inclusion\": \"no\",\n            \"is_active\": true,\n            \"language\": \"en\",\n            \"default_manager_provided_script\": \"Hi, I’m (insert name), I am an (credentials) based in (location). I specialize in (top 1-3 conditions). I look forward to connecting with you.\",\n            \"default_user_provided_title\": \"Psychology Today Video\",\n            \"created_date_time\": \"2025-07-22T02:29:50.788397Z\",\n            \"modified_date_time\": \"2025-07-22T02:37:27.570049Z\"\n        },\n        {\n            \"id\": \"3c0a6647-d7a8-4859-88aa-85d36f21da23\",\n            \"container_type\": \"subscription\",\n            \"name\": \"Profile Video\",\n            \"description\": \"This is the description for your profile video. It should be 30-90 seconds and give the user an idea of who you are.\",\n            \"video_hosting_enabled\": true,\n            \"video_download_enabled\": true,\n            \"manager_review_required\": false,\n            \"video_format\": \"landscape\",\n            \"video_formats\": [\n                \"landscape\"\n            ],\n            \"recording_video_orientation\": \"landscape\",\n            \"subtitles_inclusion\": \"defer_to_user\",\n            \"lower_thirds_inclusion\": \"defer_to_user\",\n            \"music_inclusion\": \"defer_to_user\",\n            \"is_active\": true,\n            \"language\": \"en\",\n            \"default_manager_provided_script\": \"Hi, my name is\",\n            \"default_user_provided_title\": \"Profile Video\",\n            \"created_date_time\": \"2023-06-08T06:31:50.760447Z\",\n            \"modified_date_time\": \"2025-07-22T22:24:08.171029Z\"\n        }\n    ]\n}\n\n

next and previous: URLs for pagination if there are more templates available.
\n
results: An array of video container template objects.
\n
- id: The unique identifier of the template, represented as a string.
  \n
- container_type: single or subscription
  \n
- name: The name of the template, represented as a string.
  \n
- description: The description of the template, represented as a string.
  \n
- video_hosting_enabled: A boolean indicating whether or not video hosting is enabled for all child projects.
  \n
- manager_review_required: A boolean indicating whether a manager must review each project prior to publishing (future functionality).
  \n
- video_format: (Deprecated) The output aspect ratio ( landscape, portrait, or square) of the videos produced for all child projects.
  \n
- video_formats: A list of output aspect ratios (landscape, portrait, or square) of the videos produced for all child projects.
  \n
- recording_video_orientation: The orientation (landscape, portrait) of the recorded videos for all child projects.
  \n
- subtitles_inclusion: Indicates whether or not subtitles can be included in the videos produced for all child projects ( yes, no, defer_to_user)
  \n
- lower_thirds_inclusion: Indicates whether or not lower thirds (i.e., name and title) can be included in the videos produced for all child projects ( yes, no, defer_to_user)
  \n
- music_inclusion: Indicates whether or not music can be included in the videos produced for all child projects ( yes, no, defer_to_user)
  \n
- is_active: A boolean indicating whether or not new video containers can be created using this template.
  \n
- language: ISO 639 language code indicating the expected recording language for all child projects.
  \n
- default_manager_provided_script: A default script that appears in the app for all child projects.
  \n
- default_user_provided_title: A default title that appears in the app for all child projects.
  \n
- created_date_time: The date and time when the template was created, represented as a string in ISO 8601 format.
  \n
- modified_date_time: The date and time when the template was last modified, represented as a string in ISO 8601 format.
  \n
\n

Status Codes

200 OK: The request was successful, and the video container templates were retrieved.
\n
500 Internal Server Error: If there was an error processing the request on the server side.
\n

\n","urlObject":{"path":["api","v1","video_container_templates"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3b20991-78be-4df5-8b77-2e3c088fee20"},{"name":"Create Video Container","id":"efd3c9b8-ff62-477c-a580-0af432bf287b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"template\": \"3c0a6647-d7a8-4859-88aa-85d36f21da23\",\n \"name\": \"Test User's Profile Video 1\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/video_containers","description":"

Create Video Container API Endpoint

This API endpoint allows you to create a video container in our system. A video container is an object that defines the qualities of a video. It serves as a place to hold the video, similar to a profile page.

Endpoint

POST /api/v1/video_containers

Request Body

The request body should be a JSON object with the following structure:

{\n    \"template\": \"3c0a6647-d7a8-4859-88aa-85d36f21da23\",\n    \"name\": \"Test User's Profile Video 1\"\n}\n\n

template (required): The identifier of the video container template to be used.
name (required): The name or title of the video container.

Example Response

Upon successful creation of the video container, the API will respond with a JSON object representing the created video container. The response will have the following structure:

{\n    \"id\": \"293ed91b-04a9-4060-9ba7-da77af469807\",\n    \"template\": \"765a50a6-2052-4a23-a4bd-5d7539d3998c\",\n    \"template_name\": \"Profile Video - Landscape\",\n    \"name\": \"Test User's profile video\",\n    \"description\": \"\",\n    \"hotlinking_protection_enabled\": false,\n    \"allowed_origins\": [],\n    \"language\": \"en\",\n    \"created_date_time\": \"2024-04-30T19:06:23.096601Z\",\n    \"modified_date_time\": \"2024-04-30T19:06:23.096615Z\",\n    \"video_stream\": null,\n    \"publishing_info\": null\n}\n\n

id: The unique identifier assigned to the created video container in our system.
template: The identifier of the video container template used.
name: The name or title of the video container.
description: The description of the video container.
hotlinking_protection_enabled: A boolean indicating whether hotlinking protection is enabled for the video container.
allowed_origins: An array of allowed origins for hotlinking protection.
language: ISO 639 language code indicating the expected recording language for all child projects.
created_date_time: The date and time when the video container was created in our system.
modified_date_time: The date and time when the video container was last modified in our system.
video_stream: Information about the video stream associated with the video container (currently null).

Please note that the description, hotlinking_protection_enabled, allowed_origins, and video_stream fields may be updated or populated with additional information based on your specific requirements.

Status Codes

201 Created: The video container was successfully created.
400 Bad Request: If the request body is missing or any required parameter is invalid.
500 Internal Server Error: If there was an error processing the request on the server side.

\n","urlObject":{"path":["api","v1","video_containers"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"efd3c9b8-ff62-477c-a580-0af432bf287b"},{"name":"Fetch Video Containers","id":"5b210447-dcf7-4d40-b503-b988fafc97fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/api/v1/video_containers","description":"

Get Video Containers API Endpoint

This API endpoint allows you to fetch all the video containers associated with a customer.

Endpoint

GET /api/v1/video_containers

Query Parameters

This endpoint does not require any query parameters.

Example Response

The API will respond with a JSON object representing the list of video containers. The response will have the following structure:

{\n    \"count\": 2,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"293ed91b-04a9-4060-9ba7-da77af469807\",\n            \"template\": \"765a50a6-2052-4a23-a4bd-5d7539d3998c\",\n            \"template_name\": \"Profile Video - Landscape\",\n            \"name\": \"Test User's profile video\",\n            \"description\": \"\",\n            \"hotlinking_protection_enabled\": false,\n            \"allowed_origins\": [],\n            \"language\": \"en\",\n            \"created_date_time\": \"2024-04-30T19:06:23.096601Z\",\n            \"modified_date_time\": \"2024-04-30T19:06:23.096615Z\",\n            \"video_stream\": null,\n            \"publishing_info\": null\n        },\n        {\n            \"id\": \"3f3248ab-d6ad-4658-afe1-6b5c39218859\",\n            \"template\": \"765a50a6-2052-4a23-a4bd-5d7539d3998c\",\n            \"template_name\": \"Profile Video - Landscape\",\n            \"name\": \"Test User's Profile\",\n            \"description\": \"\",\n            \"hotlinking_protection_enabled\": false,\n            \"allowed_origins\": [],\n            \"language\": \"en\",\n            \"created_date_time\": \"2024-04-30T16:52:33.191750Z\",\n            \"modified_date_time\": \"2024-04-30T16:52:33.191760Z\",\n            \"video_stream\": {\n                \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n                \"type\": \"application/x-mpegURL\",\n                \"video_format\": \"landscape\",\n                \"preview_images\": {\n                    \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                    \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                    \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n                }\n            },\n            \"publishing_info\": {\n                \"portrait\": {\n                    \"video\": {\n                        \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n                        \"type\": \"application/x-mpegURL\"\n                    },\n                    \"images\": {\n                        \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                        \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                        \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n                    }\n                },\n                \"landscape\": {\n                    \"video\": {\n                        \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n                        \"type\": \"application/x-mpegURL\"\n                    },\n                    \"images\": {\n                        \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                        \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                        \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n                    }\n                }\n            }\n        }\n    ]\n}\n\n

next: The URL of the next page of results (currently null, indicating no more pages).
previous: The URL of the previous page of results (currently null, indicating the first page).
results: An array containing the video containers associated with the customer. Each video container object has the following attributes:
- id: The unique identifier of the video container.
- template: The identifier of the video container template used.
- name: The name or title of the video container.
- description: The description of the video container.
- hotlinking_protection_enabled: A boolean indicating whether hotlinking protection is enabled for the video container.
- allowed_origins: An array of allowed origins for hotlinking protection.
- created_date_time: The date and time when the video container was created in our system.
- modified_date_time: The date and time when the video container was last modified in our system.
- video_stream: (Deprecated) Information about the video stream associated with the video container.
- publishing_info: A mapping containing the publish video information keyed by the video format.
\n

Please note that the description, hotlinking_protection_enabled, allowed_origins, and video_stream fields may contain different values based on the specific video container settings.

Status Codes

200 OK: The request was successful, and the video containers list is returned.
500 Internal Server Error: If there was an error processing the request on the server side.

\n","urlObject":{"path":["api","v1","video_containers"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5b210447-dcf7-4d40-b503-b988fafc97fa"}],"id":"b14f1950-2627-4528-b1bf-b388487b2d17","_postman_id":"b14f1950-2627-4528-b1bf-b388487b2d17","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":true,"source":{"_postman_id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","name":"TakeOne Public API","type":"collection"}}},{"name":"Projects","item":[{"name":"Create Project","id":"2fae49c2-637b-45f3-a2de-1f101c90cde9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user\": \"c7242ea3-4592-4364-9b16-795a13007120\",\n \"video_container\": \"dfe972c0-5e1d-4ca4-b20e-fcdb1eab5ea7\",\n \"organization_display_name\": \"Test User's Profile Video 1\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/projects","description":"

Create Project API Endpoint

This API endpoint allows you to create a new project for a user with a specific video container.

Endpoint

POST /api/v1/projects

Request Body

The request body should be a JSON object with the following structure:

{\n    \"user\": \"e632e6e7-8468-400f-8d47-87c62d9b8ed5\",\n    \"video_container\": \"3f3248ab-d6ad-4658-afe1-6b5c39218859\",\n    \"organization_display_name\": \"Test User's Profile Video\"    \n}\n\n

user (required): The unique identifier of the user for whom the project is being created.
\n
video_container (required): The unique identifier of the video container associated with the project.
\n
organization_display_name (optional): The display name of the organization associated with the project.
\n

Example Response

Upon successful creation of the project, the API will respond with a JSON object representing the created project. The response will have the following structure:

{\n    \"id\": \"f15dce43-4f6b-43e4-b287-a1cb98399721\",\n    \"video_container\": \"3f3248ab-d6ad-4658-afe1-6b5c39218859\",\n    \"user\": \"e632e6e7-8468-400f-8d47-87c62d9b8ed5\",\n    \"state\": \"recording\",\n    \"organization_display_name\": \"Test User's Profile Video\",\n    \"tripod_inclusion\": null,\n    \"user_provided_title\": \"\",\n    \"script_inclusion\": null,\n    \"script\": null,\n    \"manager_provided_script\": \"\",\n    \"font_size\": null,\n    \"font_speed\": null,\n    \"publishing_status\": \"cannot_publish\",\n    \"language\": \"en\",\n    \"created_date_time\": \"2024-04-30T19:14:41.393411Z\",\n    \"modified_date_time\": \"2024-04-30T19:14:41.393421Z\",\n    \"published_video_stream\": null,\n    \"publishing_info\": null,\n    \"preview_info\": null,\n    \"preview_streaming_url\": null,\n    \"preview_thumbnail_image_url\": null\n}\n\n

id: The unique identifier assigned to the created project.
\n
video_container: The identifier of the video container associated with the project.
\n
user: The identifier of the user associated with the project.
\n
state: The current state of the project (e.g., recording, editing, completed).
\n
organization_display_name: The display name of the organization associated with the project.
\n
tripod_inclusion: Indicates whether a tripod is included in the project (e.g., with_tripod, without_tripod).
\n
user_provided_title: The title provided by the user for the project.
\n
script_inclusion: Indicates whether a script is included in the project (e.g., scripted, unscripted).
\n
script: The script content for the project.
\n
manager_provided_script: A default script that was provided for the user.
\n
font_size: The font size used in the project.
\n
font_speed: The speed of the font in the project.
\n
publishing_status: The publishing status of the project (e.g., can_publish, cannot_publish).
\n
published_video_stream:(Deprecated) Information about the published video stream associated with the project.
\n
publishing_info: A mapping containing the published video information keyed by the video format.
\n
preview_info: A mapping containing URLs for low resolution video and thumbnail keyed by the video format. You can use this to review on your side prior to publishing.
\n
preview_streaming_url:(Deprecated) A URL for a low resolution preview video.
\n
preview_thumbnail_image_url:(Deprecated) A URL for a low resolution preview video.
\n
created_date_time: The date and time when the project was created.
\n
modified_date_time: The date and time when the project was last modified.
\n

Please note that the user_provided_title, script, and manager_provided_script fields may be updated or populated with additional information based on your specific requirements.

Status Codes

201 Created: The project was successfully created.
\n
400 Bad Request: If the request body
\n

\n","urlObject":{"path":["api","v1","projects"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2fae49c2-637b-45f3-a2de-1f101c90cde9"},{"name":"Fetch Projects","id":"b104aabe-7c8a-4e72-9b64-99bb92c51c1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/api/v1/projects","description":"

Get Projects API Endpoint

This API endpoint allows you to retrieve all the projects associated with a user.

Endpoint

GET /api/v1/projects

Query Parameters

user_id (optional)

Description: The unique identifier of the user for whom the projects are to be retrieved.

Example:

/api/v1/projects?user_id=8902e50f-24fe-473d-9495-33a7cf73gdst

video_container (optional)

Description: The unique identifier of the video container for which projects are to be retrieved.

Example:

/api/v1/projects?video_container=29f20cb4-asdf-44g9-a4ce-afd2b82bgdsa

Example Response

The API will respond with a JSON object representing the list of projects. The response will have the following structure:

{\n    \"count\": 2,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"f15dce43-4f6b-43e4-b287-a1cb98399721\",\n            \"video_container\": \"3f3248ab-d6ad-4658-afe1-6b5c39218859\",\n            \"user\": \"e632e6e7-8468-400f-8d47-87c62d9b8ed5\",\n            \"state\": \"recording\",\n            \"organization_display_name\": \"Test User's Profile Video\",\n            \"tripod_inclusion\": null,\n            \"user_provided_title\": \"\",\n            \"script_inclusion\": null,\n            \"script\": null,\n            \"manager_provided_script\": \"\",\n            \"font_size\": null,\n            \"font_speed\": null,\n            \"publishing_status\": \"cannot_publish\",\n            \"language\": \"en\",\n            \"created_date_time\": \"2024-04-30T19:14:41.393411Z\",\n            \"modified_date_time\": \"2024-04-30T19:14:41.393421Z\",\n            \"published_video_stream\": null,\n            \"publishing_info\": null,\n            \"preview_info\": null,\n            \"preview_streaming_url\": null,\n            \"preview_thumbnail_image_url\": null\n        },\n        {\n            \"id\": \"7e9612d9-f2c6-459a-9c64-7fa4792bbd2e\",\n            \"video_container\": \"3f3248ab-d6ad-4658-afe1-6b5c39218859\",\n            \"user\": \"e632e6e7-8468-400f-8d47-87c62d9b8ed5\",\n            \"state\": \"completed\",\n            \"organization_display_name\": null,\n            \"tripod_inclusion\": null,\n            \"user_provided_title\": null,\n            \"script_inclusion\": null,\n            \"script\": null,\n            \"manager_provided_script\": null,\n            \"font_size\": null,\n            \"font_speed\": null,\n            \"publishing_status\": \"published\",\n            \"language\": \"en\",\n            \"created_date_time\": \"2024-04-30T16:52:33.245589Z\",\n            \"modified_date_time\": \"2024-04-30T18:17:14.330510Z\",\n            \"published_video_stream\": {\n                \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n                \"type\": \"application/x-mpegURL\",\n                \"video_format\": \"landscape\",\n                \"preview_images\": {\n                    \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                    \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                    \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n                }\n            },\n            \"publishing_info\": {\n                \"portrait\": {\n                    \"video\": {\n                        \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n                        \"type\": \"application/x-mpegURL\"\n                    },\n                    \"images\": {\n                        \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                        \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                        \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n                    }\n                },\n                \"landscape\": {\n                    \"video\": {\n                        \"src\": \"https://customer-xxxxxx.cloudflarestream.com/xxxxxx/manifest/video.m3u8\",\n                        \"type\": \"application/x-mpegURL\"\n                    },\n                    \"images\": {\n                        \"original\": \"https://imagedelivery.net/xxxxxx/xxxxxx/original\",\n                        \"high_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/3840\",\n                        \"medium_res\": \"https://imagedelivery.net/xxxxxx/xxxxxx/1920\"\n                    }\n                }\n            },\n            \"preview_info\": {\n                \"landscape\": {\n                    \"video_url\": \"https://example.com/xxyyzz.mov\",\n                    \"image_url\": \"https://example.com/xxyyzz.png\"\n                }\n            },\n            \"preview_streaming_url\": \"https://example.com/xxyyzz.mov\",\n            \"preview_thumbnail_image_url\": \"https://example.com/xxyyzz.png\"\n        }\n    ]\n}\n\n

next: The URL of the next page of results (currently null, indicating no more pages).
previous: The URL of the previous page of results (currently null, indicating the first page).
results: An array containing the projects associated with the user. Each project object has the following attributes:
- id: The unique identifier of the project.
- video_container: The identifier of the video container associated with the project.
- user: The identifier of the user associated with the project.
- state: The current state of the project (e.g., recording, editing, completed).
- organization_display_name: The display name of the organization associated with the project.
- tripod_inclusion: Indicates whether a tripod is included in the project (e.g., with_tripod, without_tripod).
- user_provided_title: The title provided by the user for the project.
- script_inclusion: Indicates whether a script is included in the project (e.g., scripted, unscripted).
- script: The script content for the project.
- manager_provided_script: A default script that was provided for the user.
- font_size: The font size used in the project.
- font_speed: The speed of the font in the project.
- publishing_status: The publishing status of the project (e.g., can_publish, cannot_publish).
- published_video_stream:(Deprecated) Information about the published video stream associated with the project.
- publishing_info: A mapping containing the published video information keyed by the video format.
- preview_info: A mapping containing URLs for low resolution video and thumbnail keyed by the video format. You can use this to review on your side prior to publishing.
- preview_streaming_url:(Deprecated) A URL for a low resolution preview video.
- preview_thumbnail_image_url:(Deprecated) A URL for a low resolution preview video.
- created_date_time: The date and time when the project was created.
- modified_date_time: The date and time when the project was last modified.
\n

Please note that the user_provided_title, script, font_size, font_speed, and publishing_status fields may contain different values based on the specific project settings.

Status Codes

200 OK: The request was successful, and the projects list is returned.
500 Internal Server Error: If there was an error processing the request on the server side.

\n","urlObject":{"path":["api","v1","projects"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b104aabe-7c8a-4e72-9b64-99bb92c51c1c"},{"name":"Publish Project","id":"dcd592e9-6d7f-4bba-a7ac-fd17391afef0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{base_url}}/api/v1/projects/7962acf1-a7ab-4d52-af35-053d0c8c9e2c/publish","description":"

Publish Project API Endpoint

This API endpoint allows you to initiate the publishing process. When publishing has completed, the video will be available for streaming and a project_published notification will be sent to the configured webhook URL.

Endpoint

POST /api/v1/projects/{{project_id}}/publish

Request Body

This endpoint does not require a request body.

Example Response

The API will respond with a JSON object representing the

{\n    \"id\": \"7e9612d9-f2c6-459a-9c64-7fa4792bbd2e\",\n    \"video_container\": \"3f3248ab-d6ad-4658-afe1-6b5c39218859\",\n    \"user\": \"e632e6e7-8468-400f-8d47-87c62d9b8ed5\",\n    \"state\": \"completed\",\n    \"organization_display_name\": null,\n    \"tripod_inclusion\": null,\n    \"user_provided_title\": null,\n    \"script_inclusion\": null,\n    \"script\": null,\n    \"manager_provided_script\": null,\n    \"font_size\": null,\n    \"font_speed\": null,\n    \"publishing_status\": \"publishing\",\n    \"language\": \"en\",\n    \"created_date_time\": \"2024-04-30T16:52:33.245589Z\",\n    \"modified_date_time\": \"2024-04-30T18:17:14.330510Z\",\n    \"published_video_stream\": null,\n    \"publishing_info\": null,\n    \"preview_info\": {\n        \"landscape\": {\n            \"video_url\": \"https://example.com/xxyyzz.mov\",\n            \"image_url\": \"https://example.com/xxyyzz.png\"\n         }\n     },\n     \"preview_streaming_url\": \"https://example.com/xxyyzz.mov\",\n     \"preview_thumbnail_image_url\": \"https://example.com/xxyyzz.png\"\n}\n\n

id: The unique identifier assigned to the created project.
video_container: The identifier of the video container associated with the project.
user: The identifier of the user associated with the project.
state: The current state of the project (e.g., recording, editing, completed).
organization_display_name: The display name of the organization associated with the project.
tripod_inclusion: Indicates whether a tripod is included in the project (e.g., with_tripod, without_tripod).
user_provided_title: The title provided by the user for the project.
script_inclusion: Indicates whether a script is included in the project (e.g., scripted, unscripted).
script: The script content for the project.
manager_provided_script: A default script that was provided for the user.
font_size: The font size used in the project.
font_speed: The speed of the font in the project.
publishing_status: The publishing status of the project (e.g., can_publish, cannot_publish).
published_video_stream:(Deprecated) Information about the published video stream associated with the project.
publishing_info: A mapping containing the published video information keyed by the video format.
preview_info: A mapping containing URLs for low resolution video and thumbnail keyed by the video format. You can use this to review on your side prior to publishing.
preview_streaming_url:(Deprecated) A URL for a low resolution preview video.
preview_thumbnail_image_url:(Deprecated) A URL for a low resolution preview video.
created_date_time: The date and time when the project was created.
modified_date_time: The date and time when the project was last modified.

Please note that the user_provided_title, script, font_size, font_speed, and publishing_status fields may contain different values based on the specific project settings.

Status Codes

200 OK: The request was successful, and the projects list is returned.
400 Bad Request: The project publishing status is currently cannot_publish.
404 Not Found: The project ID is invalid.
500 Internal Server Error: If there was an error processing the request on the server side.

\n","urlObject":{"path":["api","v1","projects","7962acf1-a7ab-4d52-af35-053d0c8c9e2c","publish"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dcd592e9-6d7f-4bba-a7ac-fd17391afef0"},{"name":"Unpublish Project","id":"5b697914-0676-466e-b166-63c31406278e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{base_url}}/api/v1/projects/7962acf1-a7ab-4d52-af35-053d0c8c9e2c/unpublish","description":"

Unpublish Project API Endpoint

This API endpoint allows you to initiate the unpublishing process. When publishing has completed, the video will no longer be available for streaming and a project_unpublished notification will be sent to the configured webhook URL.

Endpoint

POST /api/v1/projects/{{project_id}}/unpublish

Request Body

This endpoint does not require a request body.

Example Response

The API will respond with a JSON object representing the

{\n    \"id\": \"7e9612d9-f2c6-459a-9c64-7fa4792bbd2e\",\n    \"video_container\": \"3f3248ab-d6ad-4658-afe1-6b5c39218859\",\n    \"user\": \"e632e6e7-8468-400f-8d47-87c62d9b8ed5\",\n    \"state\": \"completed\",\n    \"organization_display_name\": null,\n    \"tripod_inclusion\": null,\n    \"user_provided_title\": null,\n    \"script_inclusion\": null,\n    \"script\": null,\n    \"manager_provided_script\": null,\n    \"font_size\": null,\n    \"font_speed\": null,\n    \"publishing_status\": \"unpublishing\",\n    \"language\": \"en\",\n    \"created_date_time\": \"2024-04-30T16:52:33.245589Z\",\n    \"modified_date_time\": \"2024-04-30T18:17:14.330510Z\",\n    \"published_video_stream\": null,\n    \"publishing_info\": null,\n    \"preview_info\": {\n        \"landscape\": {\n            \"video_url\": \"https://example.com/xxyyzz.mov\",\n            \"image_url\": \"https://example.com/xxyyzz.png\"\n         }\n     },\n     \"preview_streaming_url\": \"https://example.com/xxyyzz.mov\",\n     \"preview_thumbnail_image_url\": \"https://example.com/xxyyzz.png\"\n}\n\n

id: The unique identifier assigned to the created project.
video_container: The identifier of the video container associated with the project.
user: The identifier of the user associated with the project.
state: The current state of the project (e.g., recording, editing, completed).
organization_display_name: The display name of the organization associated with the project.
tripod_inclusion: Indicates whether a tripod is included in the project (e.g., with_tripod, without_tripod).
user_provided_title: The title provided by the user for the project.
script_inclusion: Indicates whether a script is included in the project (e.g., scripted, unscripted).
script: The script content for the project.
manager_provided_script: A default script that was provided for the user.
font_size: The font size used in the project.
font_speed: The speed of the font in the project.
publishing_status: The publishing status of the project (e.g., can_publish, cannot_publish).
published_video_stream:(Deprecated) Information about the published video stream associated with the project.
publishing_info: A mapping containing the published video information keyed by the video format.
preview_info: A mapping containing URLs for low resolution video and thumbnail keyed by the video format. You can use this to review on your side prior to publishing.
preview_streaming_url:(Deprecated) A URL for a low resolution preview video.
preview_thumbnail_image_url:(Deprecated) A URL for a low resolution preview video.
created_date_time: The date and time when the project was created.
modified_date_time: The date and time when the project was last modified.

Please note that the user_provided_title, script, font_size, font_speed, and publishing_status fields may contain different values based on the specific project settings.

Status Codes

200 OK: The request was successful, and the projects list is returned.
400 Bad Request: The project publishing status is currently cannot_publish or publishing.
404 Not Found: The project ID is invalid.
500 Internal Server Error: If there was an error processing the request on the server side.

\n","urlObject":{"path":["api","v1","projects","7962acf1-a7ab-4d52-af35-053d0c8c9e2c","unpublish"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5b697914-0676-466e-b166-63c31406278e"}],"id":"b79c0cb0-4715-40be-9695-1dc74712c863","_postman_id":"b79c0cb0-4715-40be-9695-1dc74712c863","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":true,"source":{"_postman_id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","name":"TakeOne Public API","type":"collection"}}},{"name":"Script Generations","item":[{"name":"Fetch Script Generation Templates","id":"d3ad4a79-7eaf-4f65-b92a-2b4316eeb655","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/video_container_templates/{{video_container_template_id}}/script_generation_templates","description":"

Example Response

{\n    \"count\": 1,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"ce32c900-e7b2-49f6-8bde-2ef1c268b22d\",\n            \"name\": \"Bio Script\",\n            \"description\": \"This prompt will take user's name and bio to generate a 90-second profile video script.\",\n            \"video_container_template\": \"3c0a6647-d7a8-4859-88aa-85d36f21da23\",\n            \"prompt_parameters_schema\": {\n                \"$id\": \"https://takeone.video/schemas/coloring/parameters/0.2.0\",\n                \"type\": \"object\",\n                \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n                \"required\": [\n                    \"name\",\n                    \"bio\"\n                ],\n                \"properties\": {\n                    \"bio\": {\n                        \"type\": \"string\",\n                        \"minLength\": 10\n                    },\n                    \"name\": {\n                        \"type\": \"string\"\n                    }\n                }\n            },\n            \"active\": true,\n            \"created_date_time\": \"2024-01-23T23:48:24.959108Z\",\n            \"modified_date_time\": \"2024-01-23T23:48:24.959124Z\"\n        }\n    ]\n}\n\n

Example Response

{\n    \"id\": \"ce32c900-e7b2-49f6-8bde-2ef1c268b22d\",\n    \"name\": \"Bio Script\",\n    \"description\": \"This prompt will take user's name and bio to generate a 90-second profile video script.\",\n    \"video_container_template\": \"3c0a6647-d7a8-4859-88aa-85d36f21da23\",\n    \"prompt_parameters_schema\": {\n        \"$id\": \"https://takeone.video/schemas/coloring/parameters/0.2.0\",\n        \"type\": \"object\",\n        \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n        \"required\": [\n            \"name\",\n            \"bio\"\n        ],\n        \"properties\": {\n            \"bio\": {\n                \"type\": \"string\",\n                \"minLength\": 10\n            },\n            \"name\": {\n                \"type\": \"string\"\n            }\n        }\n    },\n    \"active\": true,\n    \"created_date_time\": \"2024-01-23T23:48:24.959108Z\",\n    \"modified_date_time\": \"2024-01-23T23:48:24.959124Z\"\n}\n\n

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":true,"source":{"_postman_id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","name":"TakeOne Public API","type":"collection"}},"urlObject":{"path":["api","v1","video_container_templates","{{video_container_template_id}}","script_generation_templates","{{script_generation_template_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0cd0d3d1-4a9a-43dd-b94b-cb039f344835"},{"name":"Create Script Generation (for Video Container)","id":"2504248e-8ef1-424d-b997-f25fb0f7fda9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"template\": \"ce32c900-e7b2-49f6-8bde-2ef1c268b22d\",\n \"parameters\": {\n \"name\": \"John\",\n \"bio\": \"John Hartquist is a software engineer from Portland, Oregon specializing in full-stack web development and machine learning.\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/video_containers/{{video_container_id}}/script_generations","description":"

Example Request Body:

{\n    \"template\": \"ce32c900-e7b2-49f6-8bde-2ef1c268b22d\",\n    \"parameters\": {\n        \"name\": \"John\",\n        \"bio\": \"John Hartquist is a software engineer from Portland, Oregon specializing in full-stack web development and machine learning.\"\n    }\n}\n\n

Example Response:

{\n    \"id\": \"511e2cde-5b3f-416c-baa1-359284a2bb27\",\n    \"state\": \"initialized\",\n    \"template\": \"ce32c900-e7b2-49f6-8bde-2ef1c268b22d\",\n    \"prompt_parameters\": {\n        \"name\": \"John\",\n        \"bio\": \"John Hartquist is a software engineer from Portland, Oregon specializing in full-stack web development and machine learning.\"\n    },\n    \"script\": \"\",\n    \"created_date_time\": \"2025-07-25T22:40:06.852259Z\",\n    \"modified_date_time\": \"2025-07-25T22:40:06.852277Z\"\n}\n\n

Example Respones:

{\n    \"count\": 2,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"511e2cde-5b3f-416c-baa1-359284a2bb27\",\n            \"state\": \"error\",\n            \"template\": \"ce32c900-e7b2-49f6-8bde-2ef1c268b22d\",\n            \"prompt_parameters\": {\n                \"bio\": \"John Hartquist is a software engineer from Portland, Oregon specializing in full-stack web development and machine learning.\",\n                \"name\": \"John\"\n            },\n            \"script\": \"\",\n            \"created_date_time\": \"2025-07-25T22:40:06.852259Z\",\n            \"modified_date_time\": \"2025-07-25T22:40:11.446249Z\"\n        },\n        {\n            \"id\": \"dcb4e6cb-9ea0-4beb-bb2f-b460e19dd264\",\n            \"state\": \"completed\",\n            \"template\": \"ce32c900-e7b2-49f6-8bde-2ef1c268b22d\",\n            \"prompt_parameters\": {\n                \"bio\": \"John Hartquist is a software engineer from Portland, Oregon specializing in full-stack web development and machine learning.\",\n                \"name\": \"John\"\n            },\n            \"script\": \"Hi, I'm John Hartquist, a software engineer from Portland, Oregon. I specialize in full-stack web development and machine learning, crafting innovative solutions to complex problems.\",\n            \"created_date_time\": \"2025-07-25T22:49:35.082182Z\",\n            \"modified_date_time\": \"2025-07-25T22:49:38.610059Z\"\n        }\n    ]\n}\n\n

Example Response

{\n    \"id\": \"dcb4e6cb-9ea0-4beb-bb2f-b460e19dd264\",\n    \"state\": \"completed\",\n    \"template\": \"ce32c900-e7b2-49f6-8bde-2ef1c268b22d\",\n    \"prompt_parameters\": {\n        \"bio\": \"John Hartquist is a software engineer from Portland, Oregon specializing in full-stack web development and machine learning.\",\n        \"name\": \"John\"\n    },\n    \"script\": \"Hi, I'm John Hartquist, a software engineer from Portland, Oregon. I specialize in full-stack web development and machine learning, crafting innovative solutions to complex problems.\",\n    \"created_date_time\": \"2025-07-25T22:49:35.082182Z\",\n    \"modified_date_time\": \"2025-07-25T22:49:38.610059Z\"\n}\n\n

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":true,"source":{"_postman_id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","name":"TakeOne Public API","type":"collection"}},"urlObject":{"path":["api","v1","video_containers","{{video_container_id}}","script_generations","{{script_generation_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6b0b36de-d5de-476e-abc1-6bb01606d8f5"}],"id":"526ca61e-3739-4310-86be-22dffdc9f8f8","_postman_id":"526ca61e-3739-4310-86be-22dffdc9f8f8","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":true,"source":{"_postman_id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","name":"TakeOne Public API","type":"collection"}}},{"name":"Headshot Containers","item":[{"name":"Fetch Headshot Container Templates","id":"4be3b1e1-4b89-44f5-8654-b1d569ba2ea2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/headshot_container_templates","description":"

Example Response

{\n    \"count\": 1,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"92d5ad79-19e3-4029-8eba-3e829692810c\",\n            \"container_type\": \"subscription\",\n            \"is_active\": true,\n            \"name\": \"Headshot\",\n            \"description\": \"\",\n            \"default_user_provided_title\": \"Headshot\",\n            \"image_download_enabled\": true,\n            \"manager_review_required\": false,\n            \"number_of_shots\": 3,\n            \"image_capture_orientation\": \"portrait\",\n            \"output_image_formats\": [\n                \"square\"\n            ],\n            \"output_image_width\": 768,\n            \"created_date_time\": \"2025-02-28T18:49:11.563442Z\",\n            \"modified_date_time\": \"2025-05-08T16:52:53.984773Z\"\n        }\n    ]\n}\n\n

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":true,"source":{"_postman_id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","name":"TakeOne Public API","type":"collection"}},"urlObject":{"path":["api","v1","headshot_container_templates"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4be3b1e1-4b89-44f5-8654-b1d569ba2ea2"},{"name":"Create Headshot Container","id":"eb2d3b38-7638-4a26-b07e-a02a59e3fa6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"template\": \"92d5ad79-19e3-4029-8eba-3e829692810c\",\n \"user\": \"c762c729-a660-4241-b4e9-0b41e1f0652e\",\n \"name\": \"John's Headshot Container\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/headshot_containers","description":"

Example Request Body

{\n    \"template\": \"92d5ad79-19e3-4029-8eba-3e829692810c\",\n    \"user\": \"c762c729-a660-4241-b4e9-0b41e1f0652e\",\n    \"name\": \"John's Headshot Container\"\n}\n\n

Example Response

{\n    \"id\": \"14fd1b10-df73-4487-b411-6fe3af9fbcfc\",\n    \"template\": \"92d5ad79-19e3-4029-8eba-3e829692810c\",\n    \"template_name\": \"Headshot\",\n    \"user\": \"c762c729-a660-4241-b4e9-0b41e1f0652e\",\n    \"name\": \"John's Headshot Container\",\n    \"description\": \"\",\n    \"created_date_time\": \"2025-07-25T23:09:15.537057Z\",\n    \"modified_date_time\": \"2025-07-25T23:09:15.537073Z\"\n}\n\n

Example Response

{\n    \"count\": 28,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"57def2ae-0734-491f-9142-aebeefb8c2b0\",\n            \"template\": \"92d5ad79-19e3-4029-8eba-3e829692810c\",\n            \"template_name\": \"Headshot\",\n            \"user\": \"50c32af1-bd99-490f-b2de-83211030cbb3\",\n            \"name\": \"Test User Project\",\n            \"description\": \"\",\n            \"created_date_time\": \"2025-06-30T22:20:22.049403Z\",\n            \"modified_date_time\": \"2025-06-30T22:20:22.049420Z\"\n        },\n        {\n            \"id\": \"dd15b338-13c9-4648-9d88-b64e063bb1cf\",\n            \"template\": \"92d5ad79-19e3-4029-8eba-3e829692810c\",\n            \"template_name\": \"Headshot\",\n            \"user\": \"c762c729-a660-4241-b4e9-0b41e1f0652e\",\n            \"name\": \"John Hartquist\",\n            \"description\": \"\",\n            \"created_date_time\": \"2025-05-30T23:37:05.365534Z\",\n            \"modified_date_time\": \"2025-05-30T23:37:05.365547Z\"\n        }\n    ]\n}\n\n

Example Response

{\n    \"id\": \"dd15b338-13c9-4648-9d88-b64e063bb1cf\",\n    \"template\": \"92d5ad79-19e3-4029-8eba-3e829692810c\",\n    \"template_name\": \"Headshot\",\n    \"user\": \"c762c729-a660-4241-b4e9-0b41e1f0652e\",\n    \"name\": \"John Hartquist\",\n    \"description\": \"\",\n    \"created_date_time\": \"2025-05-30T23:37:05.365534Z\",\n    \"modified_date_time\": \"2025-05-30T23:37:05.365547Z\"\n}\n\n

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":true,"source":{"_postman_id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","name":"TakeOne Public API","type":"collection"}},"urlObject":{"path":["api","v1","headshot_containers","{{headshot_container_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"890a5cf8-d40e-4b13-b3fe-215994e19353"}],"id":"53ea0287-a679-45e7-b827-6f3e92d37908","_postman_id":"53ea0287-a679-45e7-b827-6f3e92d37908","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":true,"source":{"_postman_id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","name":"TakeOne Public API","type":"collection"}}},{"name":"Headshot Projects","item":[{"name":"Fetch Headshot Projects","id":"ccb275cd-cb6f-479d-bf33-cdf7c25bc85b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/headshot_projects","description":"

Example Response

{\n    \"count\": 2,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"8bd94bc0-1abb-44e9-8e54-b537b535db57\",\n            \"headshot_container\": \"57def2ae-0734-491f-9142-aebeefb8c2b0\",\n            \"user\": \"50c32af1-bd99-490f-b2de-83211030cbb3\",\n            \"state\": \"processing\",\n            \"organization_display_name\": \"Test User Project\",\n            \"tripod_inclusion\": null,\n            \"user_provided_title\": \"Headshot\",\n            \"created_date_time\": \"2025-06-30T22:20:22.421668Z\",\n            \"modified_date_time\": \"2025-06-30T22:22:29.365781Z\",\n            \"shots\": null\n        },\n        {\n            \"id\": \"bacad97f-139b-4b50-93c6-c4ff2bad8381\",\n            \"headshot_container\": \"dd15b338-13c9-4648-9d88-b64e063bb1cf\",\n            \"user\": \"c762c729-a660-4241-b4e9-0b41e1f0652e\",\n            \"state\": \"capturing\",\n            \"organization_display_name\": null,\n            \"tripod_inclusion\": null,\n            \"user_provided_title\": \"Headshot\",\n            \"created_date_time\": \"2025-05-30T23:37:05.482445Z\",\n            \"modified_date_time\": \"2025-05-30T23:37:05.482459Z\",\n            \"shots\": null\n        },\n    ]\n}\n\n

Example Response

{\n    \"id\": \"8bd94bc0-1abb-44e9-8e54-b537b535db57\",\n    \"headshot_container\": \"57def2ae-0734-491f-9142-aebeefb8c2b0\",\n    \"user\": \"50c32af1-bd99-490f-b2de-83211030cbb3\",\n    \"state\": \"processing\",\n    \"organization_display_name\": \"Test User Project\",\n    \"tripod_inclusion\": null,\n    \"user_provided_title\": \"Headshot\",\n    \"created_date_time\": \"2025-06-30T22:20:22.421668Z\",\n    \"modified_date_time\": \"2025-06-30T22:22:29.365781Z\",\n    \"shots\": null\n}\n\n

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":true,"source":{"_postman_id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","name":"TakeOne Public API","type":"collection"}},"urlObject":{"path":["api","v1","headshot_projects","{{headshot_project_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"69d0850a-19b3-4043-8532-fc6b65a51c20"},{"name":"Create Headshot Project","id":"f78de0ca-a688-46c6-8806-021dffe74c5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"headshot_container\": \"dd15b338-13c9-4648-9d88-b64e063bb1cf\",\n \"user\": \"c762c729-a660-4241-b4e9-0b41e1f0652e\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/headshot_projects","description":"

Example Request Body

{\n    \"headshot_container\": \"dd15b338-13c9-4648-9d88-b64e063bb1cf\",\n    \"user\": \"c762c729-a660-4241-b4e9-0b41e1f0652e\"\n}\n\n

Example Response

{\n    \"id\": \"7b61dbbf-23d5-41e3-9fea-33717ddca5d6\",\n    \"headshot_container\": \"dd15b338-13c9-4648-9d88-b64e063bb1cf\",\n    \"user\": \"c762c729-a660-4241-b4e9-0b41e1f0652e\",\n    \"state\": \"capturing\",\n    \"organization_display_name\": null,\n    \"tripod_inclusion\": null,\n    \"user_provided_title\": \"Headshot\",\n    \"created_date_time\": \"2025-07-25T23:16:09.304111Z\",\n    \"modified_date_time\": \"2025-07-25T23:16:09.304129Z\",\n    \"shots\": null\n}\n\n

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":true,"source":{"_postman_id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","name":"TakeOne Public API","type":"collection"}},"urlObject":{"path":["api","v1","headshot_projects"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f78de0ca-a688-46c6-8806-021dffe74c5c"}],"id":"48b4195f-4927-4130-a668-4bb7af492beb","_postman_id":"48b4195f-4927-4130-a668-4bb7af492beb","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]},"isInherited":true,"source":{"_postman_id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","id":"fde91e9f-a6c9-4143-9c69-fea3db5191be","name":"TakeOne Public API","type":"collection"}}}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{confidential_client_id}}"},{"key":"password","value":"{{confidential_client_secret}}"}]}},"event":[{"listen":"prerequest","script":{"id":"c81b3d66-51c2-4bd6-983c-4d8e3a75ad13","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c3b410da-c1be-4405-a995-2f653cb14519","type":"text/javascript","exec":[""]}}]}