Skip to main content
GET
/
api
/
object
/
{objid}
View object.
curl --request GET \
  --url https://api.coinfer.ai/api/object/{objid} \
  --header 'X-Share-Password: <api-key>'
{
  "status": "<string>",
  "data": {
    "object_type": "<string>",
    "short_id": "",
    "name": "",
    "model_id": "",
    "status": "",
    "meta": "<any>",
    "n_chains": 0,
    "n_variables": 0,
    "n_samples": 0,
    "sample_update_time": "",
    "run_on": "",
    "input": "<string>",
    "output": "<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

​
X-Share-Password
string
header
required

Path Parameters

​
objid
string
required

Query Parameters

​
object_type
enum<string>
default:""
Available options:
model,
experiment,
share,
event,
callback,
relation,
data,
workflow,
​
share_id
string
default:""
Only appicable to object_type == model or object_type == experiment
            If this field is empty, returns the latest version of the objects.
            otherwise returns the specified share snapshot
​
sampledata
boolean
default:false
​
fmt
enum<string>
default:csv
Available options:
csv,
grist,
arviz
​
n_iteration
integer | null

Number of iterations to sample

​
cloudwatch_log
boolean
default:false
​
batch_id
string
default:""
​
run_id
string
default:""
​
view-analyzer
boolean
default:false

view analyzer result

Response

OK

​
status
string
required
Allowed value: "ok"
​
data
object
required
  • ExperimentRsp
  • ViewModelsRsp
  • ViewExperimentShareRsp
  • ExperimentSampleDataRsp
  • ExperimentCloudwatchLogRsp
  • GetExperimentRunInfoRsp
  • ExperimentPlotRsp
  • CreateDataRsp
  • ViewAnalyzerRsp
  • CreateWorkflowRsp