Create project

POST /v1/projects

Authentication

Bearer Token

Request Body required

application/json

name string

domain string

make_default boolean

start_brand_extract boolean

Responses

201 Project created

application/json

project object

id string

name string

domain string | null

brand object | null

brand_status string

Enum: none, pending, processing, completed, failed, skipped

brand_error string | null

is_default boolean

created_at string

updated_at string

signing_secret string

400 Error response

401 Error response

403 Error response

409 Error response

curl -X POST 'https://screenframed.com/v1/projects' \  -H 'Authorization: Bearer YOUR_API_TOKEN' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "domain": "string",  "make_default": true,  "start_brand_extract": true}'

const response = await fetch('https://screenframed.com/v1/projects', {  method: 'POST',  headers: {      "Authorization": "Bearer YOUR_API_TOKEN",      "Content-Type": "application/json"  },  body: JSON.stringify({    "name": "string",    "domain": "string",    "make_default": true,    "start_brand_extract": true  })});const data = await response.json();console.log(data);

import requestsheaders = {    'Authorization': 'Bearer YOUR_API_TOKEN'}response = requests.post('https://screenframed.com/v1/projects', headers=headers, json={  "name": "string",  "domain": "string",  "make_default": true,  "start_brand_extract": true})print(response.json())

201 Response

{  "project": {    "id": "<string>",    "name": "<string>",    "domain": "<string>",    "brand": "<object>",    "brand_status": "none",    "brand_error": "<string>",    "is_default": true,    "created_at": "<string>",    "updated_at": "<string>"  },  "signing_secret": "<string>"}

400 Response

{  "error": {    "code": "<string>",    "message": "<string>",    "details": "<object>",    "retry_after": 123  }}

401 Response

{  "error": {    "code": "<string>",    "message": "<string>",    "details": "<object>",    "retry_after": 123  }}

403 Response

{  "error": {    "code": "<string>",    "message": "<string>",    "details": "<object>",    "retry_after": 123  }}

409 Response

{  "error": {    "code": "<string>",    "message": "<string>",    "details": "<object>",    "retry_after": 123  }}

POST /v1/projects

Base URL

Bearer Token

Request Body required application/json

Response

Was this page helpful?

Previous List hosted background packs

Next Get project