Attach SDK device

Requires an attach-only setup token. requestId enables recovery of a lost response for 10 minutes when the manifest fingerprint is unchanged. It creates no function grants.

POST/v1/sdk/devices

Authorization

AuthorizationBearer token (ol_sdk setup token) · headerrequired

Attach-only credential with a finite device limit. Attachment does not grant functions.

Request body

requiredapplication/json

requestIdstring<uuid>required

matches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

manifestManifestrequired

Show properties

namestringrequired

min length 1 · max length 64

kindstringrequired

min length 1 · max length 64 · matches ^[a-z][a-z0-9]*(?:[.-][a-z0-9]+)*$

capabilitiesstring[]required

min items 1 · max items 16

functionsobject[]

max items 16

Show properties

Array of object

namestringrequired

min length 1 · max length 64 · matches ^[a-z][a-z0-9_]*(?:\.[a-z][a-z0-9_]*)*$

titlestringrequired

min length 1 · max length 64

descriptionstringrequired

min length 1 · max length 240

accessstringrequired

Allowed:readwrite

inputSchemaobjectrequired

Show properties

typestringrequired

propertiesobjectrequired

requiredstring[]required

max items 16

additionalPropertiesbooleanrequired

Responses

201

Successful response

dataAttachedDevicerequired

Show properties

deviceIdstring<uuid>required

tokenstringrequired

Private child device credential. Returned only at enrollment/attachment; revoking the device invalidates it.

400

Invalid request or validation failure

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

401

Missing or invalid credential

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

403

Insufficient access or grant

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

404

Resource not found

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

409

Attachment retry expired or request ID reused with a different manifest

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

413

Request body exceeds the 16 KiB limit

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

429

Rate limit or workspace capacity limit

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

500

Internal error

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

503

Service or required integration is not configured

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (ol_sdk setup token)Remember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X POST 'https://www.openlaunch.dev/v1/sdk/devices' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "requestId": "00000000-0000-4000-8000-000000000001",
  "manifest": {
    "name": "board",
    "kind": "uno-r4-wifi",
    "capabilities": [
      "device.health"
    ]
  }
}'

const response: Response = await fetch("https://www.openlaunch.dev/v1/sdk/devices", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"requestId\": \"00000000-0000-4000-8000-000000000001\",\n  \"manifest\": {\n    \"name\": \"board\",\n    \"kind\": \"uno-r4-wifi\",\n    \"capabilities\": [\n      \"device.health\"\n    ]\n  }\n}"
});

import requests

response = requests.post(
    "https://www.openlaunch.dev/v1/sdk/devices",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"requestId\": \"00000000-0000-4000-8000-000000000001\",\n  \"manifest\": {\n    \"name\": \"board\",\n    \"kind\": \"uno-r4-wifi\",\n    \"capabilities\": [\n      \"device.health\"\n    ]\n  }\n}",
)

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader("{\n  \"requestId\": \"00000000-0000-4000-8000-000000000001\",\n  \"manifest\": {\n    \"name\": \"board\",\n    \"kind\": \"uno-r4-wifi\",\n    \"capabilities\": [\n      \"device.health\"\n    ]\n  }\n}")
	req, err := http.NewRequest("POST", "https://www.openlaunch.dev/v1/sdk/devices", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

Response

{
  "data": {
    "deviceId": "4de4adb9-21ee-47e3-aeb4-8cf8ed6c109a",
    "token": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}