Skip to main content

estuary_client.ContentApi

All URIs are relative to //api.estuary.tech/

MethodHTTP requestDescription
admin_invites_getGET /admin/invitesGet Estuary invites
admin_invites_postPOST /admin/invitesCreate an Estuary invite
content_add_car_postPOST /content/add-carAdd Car object
content_add_ipfs_postPOST /content/add-ipfsAdd IPFS object
content_add_postPOST /content/addAdd new content
content_aggregated_content_getGET /content/aggregated/{content}Get aggregated content stats
content_all_deals_getGET /content/all-dealsGet all deals for a user
content_bw_usage_content_getGET /content/bw-usage/{content}Get content bandwidth
content_create_postPOST /content/createAdd a new content
content_deals_getGET /content/dealsContent with deals
content_ensure_replication_datacid_getGET /content/ensure-replication/{datacid}Ensure Replication
content_failures_content_getGET /content/failures/{content}List all failures for a content
content_id_getGET /content/{id}Content
content_importdeal_postPOST /content/importdealImport a deal
content_list_getGET /content/listList all pinned content
content_read_cont_getGET /content/read/{cont}Read content
content_staging_zones_getGET /content/staging-zonesGet staging zone for user
content_stats_getGET /content/statsGet content statistics
content_status_id_getGET /content/status/{id}Content Status

admin_invites_get

str admin_invites_get()

Get Estuary invites

This endpoint is used to list all estuary invites.

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))

try:
# Get Estuary invites
api_response = api_instance.admin_invites_get()
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->admin_invites_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

admin_invites_post

str admin_invites_post(code)

Create an Estuary invite

This endpoint is used to create an estuary invite.

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
code = 'code_example' # str | Invite code to be created

try:
# Create an Estuary invite
api_response = api_instance.admin_invites_post(code)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->admin_invites_post: %s\n" % e)

Parameters

NameTypeDescriptionNotes
codestrInvite code to be created

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_add_car_post

UtilContentAddResponse content_add_car_post(body, ignore_dupes=ignore_dupes, filename=filename)

Add Car object

This endpoint is used to add a car object to the network. The object can be a file or a directory.

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
body = 'body_example' # str | Car
ignore_dupes = 'ignore_dupes_example' # str | Ignore Dupes (optional)
filename = 'filename_example' # str | Filename (optional)

try:
# Add Car object
api_response = api_instance.content_add_car_post(body, ignore_dupes=ignore_dupes, filename=filename)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_add_car_post: %s\n" % e)

Parameters

NameTypeDescriptionNotes
bodystrCar
ignore_dupesstrIgnore Dupes[optional]
filenamestrFilename[optional]

Return type

UtilContentAddResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: /
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_add_ipfs_post

str content_add_ipfs_post(body, ignore_dupes=ignore_dupes)

Add IPFS object

This endpoint is used to add an IPFS object to the network. The object can be a file or a directory.

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
body = estuary_client.UtilContentAddIpfsBody() # UtilContentAddIpfsBody | IPFS Body
ignore_dupes = 'ignore_dupes_example' # str | Ignore Dupes (optional)

try:
# Add IPFS object
api_response = api_instance.content_add_ipfs_post(body, ignore_dupes=ignore_dupes)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_add_ipfs_post: %s\n" % e)

Parameters

NameTypeDescriptionNotes
bodyUtilContentAddIpfsBodyIPFS Body
ignore_dupesstrIgnore Dupes[optional]

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: /
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_add_post

UtilContentAddResponse content_add_post(data, filename, coluuid=coluuid, replication=replication, ignore_dupes=ignore_dupes, lazy_provide=lazy_provide, dir=dir)

Add new content

This endpoint is used to upload new content.

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
data = 'data_example' # str |
filename = 'filename_example' # str |
coluuid = 'coluuid_example' # str | Collection UUID (optional)
replication = 56 # int | Replication value (optional)
ignore_dupes = 'ignore_dupes_example' # str | Ignore Dupes true/false (optional)
lazy_provide = 'lazy_provide_example' # str | Lazy Provide true/false (optional)
dir = 'dir_example' # str | Directory (optional)

try:
# Add new content
api_response = api_instance.content_add_post(data, filename, coluuid=coluuid, replication=replication, ignore_dupes=ignore_dupes, lazy_provide=lazy_provide, dir=dir)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_add_post: %s\n" % e)

Parameters

NameTypeDescriptionNotes
datastr
filenamestr
coluuidstrCollection UUID[optional]
replicationintReplication value[optional]
ignore_dupesstrIgnore Dupes true/false[optional]
lazy_providestrLazy Provide true/false[optional]
dirstrDirectory[optional]

Return type

UtilContentAddResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_aggregated_content_get

str content_aggregated_content_get(content)

Get aggregated content stats

This endpoint returns aggregated content stats

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
content = 'content_example' # str | Content ID

try:
# Get aggregated content stats
api_response = api_instance.content_aggregated_content_get(content)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_aggregated_content_get: %s\n" % e)

Parameters

NameTypeDescriptionNotes
contentstrContent ID

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_all_deals_get

str content_all_deals_get(begin, duration, all)

Get all deals for a user

This endpoint is used to get all deals for a user

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
begin = 'begin_example' # str | Begin
duration = 'duration_example' # str | Duration
all = 'all_example' # str | All

try:
# Get all deals for a user
api_response = api_instance.content_all_deals_get(begin, duration, all)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_all_deals_get: %s\n" % e)

Parameters

NameTypeDescriptionNotes
beginstrBegin
durationstrDuration
allstrAll

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_bw_usage_content_get

str content_bw_usage_content_get(content)

Get content bandwidth

This endpoint returns content bandwidth

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
content = 'content_example' # str | Content ID

try:
# Get content bandwidth
api_response = api_instance.content_bw_usage_content_get(content)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_bw_usage_content_get: %s\n" % e)

Parameters

NameTypeDescriptionNotes
contentstrContent ID

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_create_post

str content_create_post(body, ignore_dupes=ignore_dupes)

Add a new content

This endpoint adds a new content

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
body = estuary_client.UtilContentCreateBody() # UtilContentCreateBody | Content
ignore_dupes = 'ignore_dupes_example' # str | Ignore Dupes (optional)

try:
# Add a new content
api_response = api_instance.content_create_post(body, ignore_dupes=ignore_dupes)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_create_post: %s\n" % e)

Parameters

NameTypeDescriptionNotes
bodyUtilContentCreateBodyContent
ignore_dupesstrIgnore Dupes[optional]

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: /
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_deals_get

str content_deals_get(limit=limit, offset=offset)

Content with deals

This endpoint lists all content with deals

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
limit = 56 # int | Limit (optional)
offset = 56 # int | Offset (optional)

try:
# Content with deals
api_response = api_instance.content_deals_get(limit=limit, offset=offset)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_deals_get: %s\n" % e)

Parameters

NameTypeDescriptionNotes
limitintLimit[optional]
offsetintOffset[optional]

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_ensure_replication_datacid_get

str content_ensure_replication_datacid_get(datacid)

Ensure Replication

This endpoint ensures that the content is replicated to the specified number of providers

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
datacid = 'datacid_example' # str | Data CID

try:
# Ensure Replication
api_response = api_instance.content_ensure_replication_datacid_get(datacid)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_ensure_replication_datacid_get: %s\n" % e)

Parameters

NameTypeDescriptionNotes
datacidstrData CID

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_failures_content_get

str content_failures_content_get(content)

List all failures for a content

This endpoint returns all failures for a content

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
content = 'content_example' # str | Content ID

try:
# List all failures for a content
api_response = api_instance.content_failures_content_get(content)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_failures_content_get: %s\n" % e)

Parameters

NameTypeDescriptionNotes
contentstrContent ID

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_id_get

str content_id_get(id)

Content

This endpoint returns a content by its ID

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
id = 56 # int | Content ID

try:
# Content
api_response = api_instance.content_id_get(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_id_get: %s\n" % e)

Parameters

NameTypeDescriptionNotes
idintContent ID

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_importdeal_post

str content_importdeal_post(body)

Import a deal

This endpoint imports a deal into the shuttle.

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
body = estuary_client.MainImportDealBody() # MainImportDealBody | Import a deal

try:
# Import a deal
api_response = api_instance.content_importdeal_post(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_importdeal_post: %s\n" % e)

Parameters

NameTypeDescriptionNotes
bodyMainImportDealBodyImport a deal

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: /
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_list_get

str content_list_get()

List all pinned content

This endpoint lists all content

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))

try:
# List all pinned content
api_response = api_instance.content_list_get()
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_list_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_read_cont_get

str content_read_cont_get(cont)

Read content

This endpoint reads content from the blockstore

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
cont = 'cont_example' # str | CID

try:
# Read content
api_response = api_instance.content_read_cont_get(cont)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_read_cont_get: %s\n" % e)

Parameters

NameTypeDescriptionNotes
contstrCID

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_staging_zones_get

str content_staging_zones_get()

Get staging zone for user

This endpoint is used to get staging zone for user.

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))

try:
# Get staging zone for user
api_response = api_instance.content_staging_zones_get()
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_staging_zones_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_stats_get

str content_stats_get(limit, offset)

Get content statistics

This endpoint is used to get content statistics. Every content stored in the network (estuary) is tracked by a unique ID which can be used to get information about the content. This endpoint will allow the consumer to get the collected stats of a conten

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
limit = 'limit_example' # str | limit
offset = 'offset_example' # str | offset

try:
# Get content statistics
api_response = api_instance.content_stats_get(limit, offset)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_stats_get: %s\n" % e)

Parameters

NameTypeDescriptionNotes
limitstrlimit
offsetstroffset

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

content_status_id_get

str content_status_id_get(id)

Content Status

This endpoint returns the status of a content

Example

from __future__ import print_function
import time
import estuary_client
from estuary_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary_client.ContentApi(estuary_client.ApiClient(configuration))
id = 56 # int | Content ID

try:
# Content Status
api_response = api_instance.content_status_id_get(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentApi->content_status_id_get: %s\n" % e)

Parameters

NameTypeDescriptionNotes
idintContent ID

Return type

str

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]