Poll a device-code grant for completion

curl --request GET \
  --url https://www.immersivecommons.com/api/agent/signup/poll

const options = {method: 'GET'};

fetch('https://www.immersivecommons.com/api/agent/signup/poll', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.immersivecommons.com/api/agent/signup/poll",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://www.immersivecommons.com/api/agent/signup/poll"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.immersivecommons.com/api/agent/signup/poll")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "user_id": "<string>",
  "agent_token": "<string>",
  "tier": "<string>",
  "pending_tier": "<string>",
  "granted_scopes": [
    "<string>"
  ],
  "sandbox": true,
  "reason": "<string>",
  "next_steps": {}
}

{
  "error": "<string>",
  "ok": false,
  "error_kind": "<string>",
  "message": "<string>",
  "rate": {
    "current": 123,
    "remaining": 123,
    "limit": 123
  },
  "retry_after_seconds": 123,
  "tier": "<string>",
  "current_tier": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "ok": false,
  "error_kind": "<string>",
  "message": "<string>",
  "rate": {
    "current": 123,
    "remaining": 123,
    "limit": 123
  },
  "retry_after_seconds": 123,
  "tier": "<string>",
  "current_tier": "<string>",
  "detail": "<string>"
}

GET

api

agent

signup

poll

Poll a device-code grant for completion

curl --request GET \
  --url https://www.immersivecommons.com/api/agent/signup/poll

const options = {method: 'GET'};

fetch('https://www.immersivecommons.com/api/agent/signup/poll', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.immersivecommons.com/api/agent/signup/poll",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://www.immersivecommons.com/api/agent/signup/poll"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.immersivecommons.com/api/agent/signup/poll")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "user_id": "<string>",
  "agent_token": "<string>",
  "tier": "<string>",
  "pending_tier": "<string>",
  "granted_scopes": [
    "<string>"
  ],
  "sandbox": true,
  "reason": "<string>",
  "next_steps": {}
}

{
  "error": "<string>",
  "ok": false,
  "error_kind": "<string>",
  "message": "<string>",
  "rate": {
    "current": 123,
    "remaining": 123,
    "limit": 123
  },
  "retry_after_seconds": 123,
  "tier": "<string>",
  "current_tier": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "ok": false,
  "error_kind": "<string>",
  "message": "<string>",
  "rate": {
    "current": 123,
    "remaining": 123,
    "limit": 123
  },
  "retry_after_seconds": 123,
  "tier": "<string>",
  "current_tier": "<string>",
  "detail": "<string>"
}

Query Parameters

device_code

string

The device_code from /start. Omit for the self-describe contract.

Required string length: 16 - 64

Response

Grant status (pending/completed/cancelled) or the self-describe contract.

One of pending / completed / cancelled. completed surfaces the agent_token exactly once.

status

enum<string>

required

Available options:

pending,

completed,

cancelled

user_id

string

agent_token

string

Plaintext, surfaced ONCE — store it on the agent.

tier

string

pending_tier

string

granted_scopes

string[]

sandbox

boolean

Present + true when the minted token is a sandbox/test-mode token (mirrors the sandbox flag sent to /start).

reason

string

On cancellation.

next_steps

object

events

batch

directory

resources

account

leaderboard

research

highlights

feedback

auth

payments

membership

Poll a device-code grant for completion

Query Parameters

Response