TODO for AI Logo
TODOforAI API

Edge Client

Endpoint:/api/v1

List edges

GET
/api/v1
/edges

Returns a list of edges for the authenticated user

List edges › Responses

Successful operation

  • idstring
    Example: edge-123
  • namestring
    Example: My Edge
  • typestring
    Example: shell
  • statusstring
    Example: active
  • createdAtinteger · int64
    Example: 1625097600000

Get edge by ID

GET
/api/v1
/edges/{edgeId}

Returns an edge by ID

Get edge by ID › path Parameters

  • edgeIdstring · required

    ID of the edge

Get edge by ID › Responses

Successful operation

  • idstring
    Example: edge-123
  • namestring
    Example: My Edge
  • typestring
    Example: shell
  • statusstring
    Example: active
  • createdAtinteger · int64
    Example: 1625097600000

Delete an edge

DELETE
/api/v1
/edges/{edgeId}

Deletes an edge by ID

Delete an edge › path Parameters

  • edgeIdstring · required

    ID of the edge

Delete an edge › Responses

Edge deleted successfully

  • successboolean
    Example: true
  • messagestring
    Example: Operation completed successfully

Update an edge

PATCH
/api/v1
/edges/{edgeId}

Updates an edge by ID

Update an edge › path Parameters

  • edgeIdstring · required

    ID of the edge

Update an edge › Request Body

  • namestring
    Example: Updated Edge Name

Update an edge › Responses

Edge updated successfully

  • idstring
    Example: edge-123
  • namestring
    Example: My Edge
  • typestring
    Example: shell
  • statusstring
    Example: active
  • createdAtinteger · int64
    Example: 1625097600000

Subscribe to edge events

POST
/api/v1
/edges/{edgeId}/subscribe

Subscribes to events from a specific edge

Subscribe to edge events › path Parameters

  • edgeIdstring · required

    ID of the edge

Subscribe to edge events › Responses

Subscribed to edge successfully

  • successboolean
    Example: true
  • messagestring
    Example: Operation completed successfully
Datasources