API Reference

V1

Omni AI

Entitlements

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Delete Entitlement

$ clear-street v1:omni-ai:entitlements delete-entitlement

DELETE/v1/omni-ai/entitlements/{entitlement_id}

Revoke one entitlement grant by id.

ParametersExpand Collapse

--entitlement-id: string

Entitlement grant id

ReturnsExpand Collapse

V1OmniAIEntitlementDeleteEntitlementResponse: BaseResponse { metadata, error }

data: object { entitlement_id, revoked }

entitlement_id: string

revoked: boolean

Delete Entitlement

CLI Tool

HTTP

TypeScript

Python

Java

Go

CLI Tool

clear-street v1:omni-ai:entitlements delete-entitlement \
  --api-key 'My API Key' \
  --entitlement-id entitlement_id

200 example

{
  "metadata": {
    "request_id": "request_id",
    "next_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "page_number": 0,
    "previous_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "total_items": 0,
    "total_pages": 0
  },
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero",
    "details": [
      {
        "foo": "bar"
      }
    ]
  },
  "data": {
    "entitlement_id": "entitlement_id",
    "revoked": true
  }
}

Returns Examples

200 example

{
  "metadata": {
    "request_id": "request_id",
    "next_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "page_number": 0,
    "previous_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "total_items": 0,
    "total_pages": 0
  },
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero",
    "details": [
      {
        "foo": "bar"
      }
    ]
  },
  "data": {
    "entitlement_id": "entitlement_id",
    "revoked": true
  }
}