VoidhashDocs
DocumentationAPI reference
Dashboard
Essentials
API overview
Authentication
Endpoints
Ad_accounts
Analytics
Api_keys
Auth
Component_dev_sessions
Component_registry
Components
Development
Events
Experiments
Feature_flag_overrides
Feature_flag_targets
Feature_flags
Ingest_policy
Notification_sends
Notifications
Organizations
Payment_provider_configurations
Payment_provider_products
Payment_sources
Paywall_locations
Paywalls
Perks
Persons
Products
Projects
Push_notification_configurations
Schema
Sdk
Users
Webhooks
Analytics
Event capture
List Component Dev Sessions
Register Component Dev Session
Update Component Dev Session
End Component Dev Session

Register Component Dev Session

PreviousList Component Dev SessionsNextUpdate Component Dev Session
POST
/api/v1/component-dev-sessions

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

projectId?string|null
url*string
token*string
components*array<>

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/component-dev-sessions" \  -H "Content-Type: application/json" \  -d '{    "url": "string",    "token": "string",    "components": [      {        "slug": "string",        "definitionId": "string",        "title": "string",        "origin": "server",        "isModified": true,        "isConflicted": true,        "build": {          "state": "building"        }      }    ]  }'
{  "sessionId": "string",  "projectId": "string",  "url": "string",  "token": "string",  "components": [    {      "slug": "string",      "definitionId": "string",      "title": "string",      "origin": "server",      "baseVersion": 0,      "publishedVersion": 0,      "isModified": true,      "isConflicted": true,      "build": {        "state": "building",        "message": "string"      },      "moduleHash": "string",      "panelHash": "string",      "definition": null    }  ],  "createdAt": "string",  "updatedAt": "string",  "expiresAt": "string"}
{  "_tag": "Api/SdkValidationError",  "message": "string"}
{  "_tag": "Api/AuthenticationError",  "cause": "string",  "message": "string"}
{  "_tag": "Api/ActionForbiddenError",  "message": "string"}
{  "_tag": "Api/ComponentNotFoundError",  "message": "string"}
{  "_tag": "Api/ComponentInvalidError",  "message": "string",  "problems": [    "string"  ]}
{  "_tag": "Api/ComponentServiceError",  "message": "string"}