Get action status

GET

actions

{actionId}

curl

curl --request GET \
  --url 'https://api.amps.ai/actions/act_abc123' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx'

const response = await fetch('https://api.amps.ai/actions/act_abc123', {
  method: 'GET',
  headers: {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
  },
});

const data = await response.json();

import requests

url = 'https://api.amps.ai/actions/act_abc123'
headers = {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
}

response = requests.get(url, headers=headers)
data = response.json()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.amps.ai/actions/{actionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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://api.amps.ai/actions/{actionId}"

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

	req.Header.Add("x-api-key", "<api-key>")

	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://api.amps.ai/actions/{actionId}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "success": true,
  "data": {
    "id": "act_2026050709a1b2c3",
    "deviceId": "device_abc123",
    "deviceType": "battery",
    "command": "charge",
    "parameters": {
      "target": {
        "value": 100,
        "unit": "percent"
      }
    },
    "state": "scheduled",
    "result": null,
    "errorCode": null,
    "errorMessage": null,
    "createdAt": "2026-05-07T08:00:00.000Z",
    "updatedAt": "2026-05-07T08:00:00.000Z",
    "acknowledgedAt": null,
    "completedAt": null,
    "start": "2026-06-01T02:00:00.000Z",
    "end": null,
    "endedAt": null,
    "links": {
      "self": "/actions/act_2026050709a1b2c3"
    }
  },
  "meta": {
    "requestId": "req_8a2Bf3kP",
    "environment": "sandbox",
    "timestamp": "2026-06-02T12:00:00.000Z",
    "latencyMs": 12
  }
}

Authorizations

x-api-key

string

header

required

Path Parameters

actionId

string

required

The unique identifier for the action.

Example:

"act_abc123"

Response

Action status retrieved successfully.

success

boolean

required

Always true for success responses.

data

Action Response · object

required

Persistent state of a device action across its lifecycle. Mirrors the dispatch: command is the canonical verb, parameters the constraints, deviceType the device family (which discriminates the shape). Lifecycle states, timestamps, the result envelope, and links are universal.

Action Response
Action Response
Action Response

Show child attributes

meta

Response Meta · object

required

Metadata attached to every response: the request identifier, the serving environment, the build timestamp, and the server-side latency.

Show child attributes

curl

curl --request GET \
  --url 'https://api.amps.ai/actions/act_abc123' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx'

const response = await fetch('https://api.amps.ai/actions/act_abc123', {
  method: 'GET',
  headers: {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
  },
});

const data = await response.json();

import requests

url = 'https://api.amps.ai/actions/act_abc123'
headers = {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
}

response = requests.get(url, headers=headers)
data = response.json()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.amps.ai/actions/{actionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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://api.amps.ai/actions/{actionId}"

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

	req.Header.Add("x-api-key", "<api-key>")

	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://api.amps.ai/actions/{actionId}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "success": true,
  "data": {
    "id": "act_2026050709a1b2c3",
    "deviceId": "device_abc123",
    "deviceType": "battery",
    "command": "charge",
    "parameters": {
      "target": {
        "value": 100,
        "unit": "percent"
      }
    },
    "state": "scheduled",
    "result": null,
    "errorCode": null,
    "errorMessage": null,
    "createdAt": "2026-05-07T08:00:00.000Z",
    "updatedAt": "2026-05-07T08:00:00.000Z",
    "acknowledgedAt": null,
    "completedAt": null,
    "start": "2026-06-01T02:00:00.000Z",
    "end": null,
    "endedAt": null,
    "links": {
      "self": "/actions/act_2026050709a1b2c3"
    }
  },
  "meta": {
    "requestId": "req_8a2Bf3kP",
    "environment": "sandbox",
    "timestamp": "2026-06-02T12:00:00.000Z",
    "latencyMs": 12
  }
}

Get Started

Concepts

API Reference

Guides

Quick reference

More

Authorizations

Path Parameters

Response