Create Project

POST 
https://platform.nativeframe.com/dashboard/api/v1/organizations/:organizationSlug/projects

Generate JWT

Request

Path Parameters

organizationSlug stringrequired

application/json

Body

namestringrequired
slugstring

configuration

object

required

privateViewingboolean

cdnboolean

recordingboolean
descriptionstring
preferredAuthstring

Possible values: [jwtAuth, webhookAuth, public]

Responses

200

Returns the created project information

application/json

Schema

Schema

project

object

idstringrequired

namestringrequired

slugstringrequired

isLegacyProjectPrivateCloudboolean

organizationIdstringrequired

configuration

object

required

privateViewingboolean

cdnboolean

recordingboolean

descriptionstring

configuredbooleanrequired

projectConfiguration

object

preferredAuthstringrequired

projectIdstringrequired

property name*any

Example (from schema)

{
  "project": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "isLegacyProjectPrivateCloud": true,
    "organizationId": "string",
    "configuration": {
      "privateViewing": true,
      "cdn": true,
      "recording": true
    },
    "description": "string",
    "configured": true
  }
}

400

Bad Request

application/json

Schema

Schema

messagestringrequired

Error message for the end user

errorCodestring

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

namestringrequired

reasonstringrequired

errorCodestring

]

internalstring

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

401

Unauthorized

application/json

Schema

Schema

messagestringrequired

Error message for the end user

errorCodestring

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

namestringrequired

reasonstringrequired

errorCodestring

]

internalstring

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

404

Organization not found

application/json

Schema

Schema

messagestringrequired

Error message for the end user

errorCodestring

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

namestringrequired

reasonstringrequired

errorCodestring

]

internalstring

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

500

Internal Server Error

application/json

Schema

Schema

messagestringrequired

Error message for the end user

errorCodestring

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

namestringrequired

reasonstringrequired

errorCodestring

]

internalstring

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

Authorization: http

name: JWTtype: httpscheme: bearerbearerFormat: JWTdescription: Bearer Token authentication for applications

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://platform.nativeframe.com/dashboard/api/v1/organizations/:organizationSlug/projects");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"slug\": \"string\",\n  \"configuration\": {\n    \"privateViewing\": true,\n    \"cdn\": true,\n    \"recording\": true\n  },\n  \"description\": \"string\",\n  \"preferredAuth\": \"jwtAuth\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://platform.nativeframe.com

Auth

Bearer Token

Parameters

organizationSlug — pathrequired

Body

{
  "name": "string",
  "slug": "string",
  "configuration": {
    "privateViewing": true,
    "cdn": true,
    "recording": true
  },
  "description": "string",
  "preferredAuth": "jwtAuth"
}

ResponseClear

Click the Send API Request button above and see the response here!