Jump to Content
Guides
API Reference
Changelog
Discussions
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
Guides
API Reference
Changelog
Discussions
List files
Search
All
Pages
Start typing to search…
JUMP TO
Endpoints
asset_types
List asset types
get
Create an asset type
post
Retrieve an asset type
get
Update an asset type
put
Partially update an asset type
patch
Delete an asset type
del
assets
List assets
get
Create an asset
post
Retrieve an asset
get
Update an asset
put
Partially update an asset
patch
Delete an asset
del
audit_logs
List Audit Logs
get
Create an audit log
post
Retrieve an audit log
get
/api/v1/audit_logs/{id}
put
/api/v1/audit_logs/{id}
patch
/api/v1/audit_logs/{id}
del
base_runnables
List base runnables
get
Create a base runnable
post
Retrieve a base runnable
get
Update a base runnable
put
Partially update a base runnable
patch
Delete a base runnable
del
brand_settings
List brand settings
get
Create a brand setting
post
Retrieve a brand setting
get
Update a brand setting
put
Partially update a brand setting
patch
Delete a brand setting
del
bulk_retrieve
Bulk retrieve trace information
post
collection_stores
List collections
get
Create a collection
post
Retrieve a collection
get
Update a collection
put
Partially update a collection
patch
Delete a collection
del
Add documents to collection
post
Add objects to collection
post
Perform similarity search
post
collection_stores_mappings
List collection embeddings
get
Create a collection embedding
post
Retrieve a collection embedding
get
Update a collection embedding
put
Partially update a collection embedding
patch
Delete a collection embedding
del
custom_field_values
List custom field values
get
Create a custom field value
post
Retrieve a custom field value
get
Update a custom field value
put
Partially update a custom field value
patch
Delete a custom field value
del
custom_fields
List custom fields
get
Create a custom field
post
Retrieve a custom field
get
Update a custom field
put
Partially update a custom field
patch
Delete a custom field
del
deployment_artifacts
List deployment artifacts
get
Create a deployment artifact
post
Retrieve a deployment artifact
get
Update a deployment artifact
put
Partially update a deployment artifact
patch
Delete a deployment artifact
del
Download deployment artifact
get
deployment_chat_interfaces
List all deployment chat interfaces
get
Create a deployment chat interface
post
Retrieve a deployment chat interface
get
Update a deployment chat interface
put
Partially update a deployment chat interface
patch
Delete a deployment chat interface
del
deployment_execution_history
List deployment execution history
get
Retrieve deployment execution history
get
Partially update deployment execution history
patch
Delete execution history
post
deployment_form_interfaces
List all deployment form interfaces
get
Create a deployment form interface
post
Retrieve a deployment form interface
get
Update a deployment form interface
put
Partially update a deployment form interface
patch
Delete a deployment form interface
del
deployment_images
List deployment images
get
Create a deployment image
post
Retrieve a deployment image
get
Update a deployment image
put
Partially update a deployment image
patch
Delete a deployment image
del
deployment_interfaces
List deployment interfaces
get
Retrieve a deployment interface
get
Partially update a deployment interface
patch
deployments
List deployments
get
Create a deployment
post
Retrieve a deployment
get
Update a deployment
put
Partially update a deployment
patch
Delete a deployment
del
Get deployment executions
get
Invoke a deployment
post
files
List files
get
Create a file
post
Retrieve a file
get
Update a file
put
Partially update a file
patch
Delete a file
del
/api/v1/files/{id}/download
get
gateways
List gateways
get
Create a gateway
post
Retrieve a gateway
get
Update a gateway
put
Partially update a gateway
patch
Delete a gateway
del
instructions
List instructions
get
Create an instruction
post
Retrieve an instruction
get
Update an instruction
put
Partially update an instruction
patch
Delete an instruction
del
integration
/api/v1/integration/bedrock/disconnect
get
/api/v1/integration/bedrock/get_info
get
/api/v1/integration/bedrock/save_models
post
/api/v1/integration/bedrock/update_token_params
post
/api/v1/integration/databricks/disconnect
get
/api/v1/integration/databricks/get_experiments
get
/api/v1/integration/databricks/get_info
get
/api/v1/integration/databricks/get_model
get
/api/v1/integration/databricks/get_models
get
/api/v1/integration/databricks/get_monitor
get
/api/v1/integration/databricks/get_runs
get
/api/v1/integration/databricks/get_table
get
/api/v1/integration/databricks/get_versions
get
/api/v1/integration/databricks/list_catalogs
get
/api/v1/integration/databricks/list_schemas
get
/api/v1/integration/databricks/list_tables
get
/api/v1/integration/databricks/permissions
get
/api/v1/integration/databricks/process_dataset
post
/api/v1/integration/databricks/process_model
get
/api/v1/integration/databricks/run_discovery
get
/api/v1/integration/databricks/search_datasets
get
/api/v1/integration/databricks/update_token_params
post
/api/v1/integration/openai/disconnect
get
/api/v1/integration/openai/get_info
get
/api/v1/integration/openai/update_token_params
post
List resource discoveries
get
Create resource discovery
post
Retrieve resource discovery
get
Update resource discovery
put
Partially update resource discovery
patch
Delete resource discovery
del
integrations
/api/v1/integrations/get_metadata
get
layout_structures
List layout structures
get
Create layout structure
post
Retrieve layout structure
get
Update layout structure
put
Partially update layout structure
patch
Delete layout structure
del
organization_secrets
List organization secrets
get
Create an organization secret
post
Retrieve an organization secret
get
Update an organization secret
put
Partially update an organization secret
patch
Delete an organization secret
del
organization_variables
List organization variables
get
Create an organization variable
post
Retrieve an organization variable
get
Update an organization variable
put
Partially update an organization variable
patch
Delete an organization variable
del
policies
List IAM policies
get
Create an IAM policy
post
Retrieve an IAM policy
get
Update an IAM policy
put
Partially update an IAM policy
patch
Delete an IAM policy
del
resource_discovery_runs
List resource discovery runs
get
/api/v1/resource_discovery_runs
post
Retrieve resource discovery run
get
/api/v1/resource_discovery_runs/{id}
put
/api/v1/resource_discovery_runs/{id}
patch
/api/v1/resource_discovery_runs/{id}
del
resources
List resources
get
Create a resource
post
Retrieve a resource
get
Update a resource
put
Partially update a resource
patch
Delete a resource
del
Sync resource
get
roles
List roles
get
Create a role
post
Retrieve a role
get
Update a role
put
Partially update a role
patch
Delete a role
del
Add a policy to role
post
Add a user to role
post
Remove a policy from role
post
Remove a user from role
post
runnables
List runnables
get
Create a runnable
post
Retrieve a runnable
get
Update a runnable
put
Partially update a runnable
patch
Delete a runnable
del
Update runnable execution status
post
stripe_products
List stripe products
get
Create a stripe product
post
Retrieve a stripe product
get
Update a stripe product
put
Partially update a stripe product
patch
Delete a stripe product
del
total_storage_gbs
Get total file storage
get
Bedrock Usage
Add Bedrock usage
post
Google Places
Search places
get
Model AI Suggestions
Get AI-powered model detail suggestions
get
health
Health check
get
Authentication
Get current user information
get
/api/v1/whoami
post
/api/v1/whoami/{id}
put
/api/v1/whoami/{id}
del
Get internal authentication info
get
MLFlow Endpoints
artifacts
List artifacts in `path`
get
Delete artifacts
del
Download an artifact
get
Upload an artifact
put
Artifact path not implemented
post
List artifacts
get
experiments
Create experiment
post
Delete experiment
post
Get experiment
get
Get experiment by name
get
Restore experiment
post
Search experiments
post
Set experiment tag
post
Update experiment
post
models
Create logged model
post
Search logged models
post
Delete logged model
del
Get logged model
get
Finalize logged model
patch
List logged model artifacts
get
Log logged model params
post
Set logged model tags
patch
Delete logged model tag
del
Create model version
post
Delete model version
del
Delete model version tag
del
Get model version
get
Get model version download uri
get
Search model versions
get
Set model version tag
post
Transition stage
post
Update model version
patch
Delete registered model alias
del
Get model version by alias
get
Set registered model alias
post
Create registered model
post
Delete registered model
del
Delete registered model tag
del
Get registered model
get
Get latest versions
post
Rename registered model
post
Search registered models
get
Set registered model tag
post
Update registered model
patch
Log model
post
metrics
Get metric history
get
Get metric history bulk interval handler
get
runs
Create run
post
Delete run
post
Delete tag
post
Get run
get
Log batch
post
Log inputs
post
Log metric
post
Log param
post
Log outputs
post
Restore run
post
Search runs
post
Set tag
post
Update run
post
traces
Search for traceinfo records in tracking store.
get
Create a new traceinfo record in tracking store.
post
Delete traceinfo records
post
Mark an existing traceinfo
patch
Retrieve
get
Delete tags from a traceinfo
del
Set tags on a traceinfo record
patch
Create a new traceinfo record in tracking store.
post
Search for traceinfo records in tracking store.
post
Retrieve
get
Create assessment
post
Delete assessment
del
Update assessment
patch
mlflow
Not implemented
post
Graphql
get
Graphql
post
Gateway Endpoints
health
Health
get
endpoints
Get Endpoint
get
List Endpoints
get
Get Endpoint Limits
get
Set Endpoint Limits
post
chat
Chat Completions
post
Chat
post
Chat Invocation
post
completions
Completions
post
embeddings
Embeddings
post
Embeddings
post
Embeddings Invocation
post
Powered by
List files
get
https://api.fairo.ai/api/v1/files
List and search all files.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Basic
base64
Basic
:
RESPONSE
Click
Try It!
to start a request and see the response here!