List objects.

curl --request GET \
  --url https://api.coinfer.ai/api/object \
  --header 'Authorization: Bearer <token>'

{
  "status": "<string>",
  "data": {
    "total": 123,
    "page": 123,
    "count_per_page": 123,
    "objects": [
      {
        "short_id": "<string>",
        "name": "<string>",
        "model_id": "<string>",
        "status": "<string>",
        "meta": {
          "action": "",
          "iteration_count": 123
        },
        "n_chains": 123,
        "n_variables": 123,
        "n_samples": 123,
        "sample_update_time": "2023-11-07T05:31:56Z",
        "run_on": "<string>",
        "share_info": [
          {
            "id": 123,
            "password": "<string>",
            "user_id": "<string>",
            "short_id": "<string>",
            "to_user_id": "<string>"
          }
        ],
        "model_name": "<string>",
        "workflow_id": "",
        "workflow_name": ""
      }
    ]
  }
}

Object

List objects.

List Objects

By default, the API returns only objects created by the current user, excluding sharing information for performance optimization.

When shared_with_me is enabled, the API returns objects owned by other users but shared with the current user, including their sharing details.

Enabling shared_by_me will include sharing information for objects that the current user has shared with others.

Setting with_share_info to true combines both scenarios: it returns objects shared by the current user as well as objects shared with the current user, complete with their respective sharing information. This effectively merges the functionality of both shared_by_me and shared_with_me.

Example

List models:

GET /api/object?object_type=model
GET /api/object?object_type=model&shared_by_me=true
GET /api/object?object_type=model&shared_with_me=true
GET /api/object?object_type=model&with_share_info=true

List experiments:

GET /api/object?object_type=experiment
GET /api/object?object_type=experiment&shared_by_me=true
GET /api/object?object_type=experiment&shared_with_me=true
GET /api/object?object_type=experiment&with_share_info=true

GET

api

object

List objects.

curl --request GET \
  --url https://api.coinfer.ai/api/object \
  --header 'Authorization: Bearer <token>'

{
  "status": "<string>",
  "data": {
    "total": 123,
    "page": 123,
    "count_per_page": 123,
    "objects": [
      {
        "short_id": "<string>",
        "name": "<string>",
        "model_id": "<string>",
        "status": "<string>",
        "meta": {
          "action": "",
          "iteration_count": 123
        },
        "n_chains": 123,
        "n_variables": 123,
        "n_samples": 123,
        "sample_update_time": "2023-11-07T05:31:56Z",
        "run_on": "<string>",
        "share_info": [
          {
            "id": 123,
            "password": "<string>",
            "user_id": "<string>",
            "short_id": "<string>",
            "to_user_id": "<string>"
          }
        ],
        "model_name": "<string>",
        "workflow_id": "",
        "workflow_name": ""
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page_no

integer

default:1

page number

Required range: x > 0

page_size

integer

default:100

page size

Required range: 0 < x <= 1000

object_type

enum<string>

required

Available options:

model,

experiment,

share,

event,

callback,

relation,

data,

workflow,

Whether to return the related share info

shared_by_me

boolean

default:false

Filter objects shared by the current user

shared_with_me

boolean

default:false

Filter objects shared with the current user

model_ids

string[]

status

enum<string>

default:""

Available options:

NEW,

RUN,

FIN,

ERR,

run_on

enum<string>

default:""

Available options:

Lambda,

Fargate,

Local,

has_model

enum<string>

default:""

Available options:

true,

false,

Response

status

string

required

Allowed value: "ok"

data

object

required

Show child attributes

Introduction Create new object.

Guide

Object

System

Share

Notification

Authorization

List objects.

List Objects

Example

Authorizations

Query Parameters

Response