Efficient Cloud Services GraphQL APIs
There are a number of services provided by Efficient Cloud.
API Endpoints
dev:
https://graph.efficientcloud.dev/graph
Authentication
This is some information about authentication. It's quite interesting really.
Duck Duck Go
Queries
fetch_customer
StripeCustomerType!
| Name | Description |
|---|---|
project_id -
String!
|
Id of the project using the service |
Example
Query
query fetch_customer($project_id: String!) {
fetch_customer(project_id: $project_id) {
id
invoice_settings {
...InvoiceSettingTypeFragment
}
payment_methods {
...PaymentMethodTypeFragment
}
}
}
Variables
{"project_id": "xyz789"}
Response
{
"data": {
"fetch_customer": {
"id": "xyz789",
"invoice_settings": InvoiceSettingType,
"payment_methods": [PaymentMethodType]
}
}
}
find_media_library_assets
[MediaLibraryAsset!]
| Name | Description |
|---|---|
keyword -
String!
|
The search keyword |
media_library_id -
String!
|
The media library ID |
Example
Query
query find_media_library_assets($keyword: String!, $media_library_id: String!) {
find_media_library_assets(keyword: $keyword, media_library_id: $media_library_id) {
id
created_at
updated_at
media_library_id
name
content_type
original_size
filename
imageinsight_id
transcoding_id
captions_id
source_url
doc_extracted_text
saved_filename
mediaLibrary {
...MediaLibraryFragment
}
tags {
...MediaLibraryAssetTagFragment
}
imageinsight_job {
...ImageInsightJobFragment
}
transcoding_job {
...TranscodingJobFragment
}
captions {
...TranscriptionJobDetailFragment
}
}
}
Variables
{"keyword": "xyz789", "media_library_id": "abc123"}
Response
{
"data": {
"find_media_library_assets": [
{
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"media_library_id": "xyz789",
"name": "xyz789",
"content_type": "abc123",
"original_size": 123.45,
"filename": "abc123",
"imageinsight_id": "xyz789",
"transcoding_id": "abc123",
"captions_id": "xyz789",
"source_url": "abc123",
"doc_extracted_text": "abc123",
"saved_filename": "xyz789",
"mediaLibrary": MediaLibrary,
"tags": [MediaLibraryAssetTag],
"imageinsight_job": ImageInsightJob,
"transcoding_job": TranscodingJob,
"captions": TranscriptionJobDetail
}
]
}
}
get_cdn_distribution
Example
Query
query get_cdn_distribution($id: String!) {
get_cdn_distribution(id: $id) {
id
created_at
updated_at
project_id
bunny_cdn_id
endpoint
project {
...ProjectFragment
}
custom_domains {
...CDNCustomDomainFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"get_cdn_distribution": {
"id": "xyz789",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "xyz789",
"bunny_cdn_id": "abc123",
"endpoint": "xyz789",
"project": Project,
"custom_domains": [CDNCustomDomain]
}
}
}
get_file_conversion_chart
[ChartData!]
| Name | Description |
|---|---|
end_date -
DateTime!
|
The end date till when fetch the jobs |
from_date -
DateTime!
|
The starting date from when to fetch the jobs |
project_id -
String!
|
ID of the project that owns the jobs |
Example
Query
query get_file_conversion_chart($end_date: DateTime!, $from_date: DateTime!, $project_id: String!) {
get_file_conversion_chart(end_date: $end_date, from_date: $from_date, project_id: $project_id) {
chargeable_time
created_at
}
}
Variables
{
"end_date": DateTime,
"from_date": DateTime,
"project_id": "xyz789"
}
Response
{
"data": {
"get_file_conversion_chart": [
{"chargeable_time": 987.65, "created_at": DateTime}
]
}
}
get_file_conversion_job
Example
Query
query get_file_conversion_job($id: String!) {
get_file_conversion_job(id: $id) {
id
created_at
updated_at
project_id
source_url
destination_url
output_format
webhook_url
status
error_message
chargeable_time
cost
original_size
converted_size
project {
...ProjectFragment
}
milestones {
...FileConversionJobMilestoneFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"get_file_conversion_job": {
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "xyz789",
"source_url": "abc123",
"destination_url": "abc123",
"output_format": "xyz789",
"webhook_url": "abc123",
"status": "xyz789",
"error_message": "xyz789",
"chargeable_time": 123.45,
"cost": 987.65,
"original_size": 123.45,
"converted_size": 987.65,
"project": Project,
"milestones": [FileConversionJobMilestone]
}
}
}
get_file_conversion_stats
FileConversionStat
| Name | Description |
|---|---|
end_date -
DateTime!
|
End date for stats |
from_date -
DateTime!
|
Start date for stats |
project_id -
String!
|
ID of the project that owns the jobs |
Example
Query
query get_file_conversion_stats($end_date: DateTime!, $from_date: DateTime!, $project_id: String!) {
get_file_conversion_stats(end_date: $end_date, from_date: $from_date, project_id: $project_id) {
totalJobs
timeConsumed
successfulJobs
pendingJobs
totalSpending
convertedFileSize
}
}
Variables
{
"end_date": DateTime,
"from_date": DateTime,
"project_id": "xyz789"
}
Response
{
"data": {
"get_file_conversion_stats": {
"totalJobs": 123.45,
"timeConsumed": 123.45,
"successfulJobs": 123.45,
"pendingJobs": 987.65,
"totalSpending": 987.65,
"convertedFileSize": 123.45
}
}
}
get_git_account
Example
Query
query get_git_account($id: String!) {
get_git_account(id: $id) {
id
created_at
updated_at
external_service
external_username
external_display_name
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"get_git_account": {
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"external_service": "xyz789",
"external_username": "xyz789",
"external_display_name": "abc123"
}
}
}
get_image_insight_job
Example
Query
query get_image_insight_job($id: String!) {
get_image_insight_job(id: $id) {
id
created_at
project_id
source_url
destination_url
status
features
moderation_status
file_size
cost
project {
...ProjectFragment
}
objects {
...ImageObjectFragment
}
tags {
...ImageTagFragment
}
metadata {
...ImageMetadataFragment
}
moderation_nudity {
...ImageModerationNudityFragment
}
moderation_violence {
...ImageModerationViolenceFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"get_image_insight_job": {
"id": "xyz789",
"created_at": DateTime,
"project_id": "abc123",
"source_url": "xyz789",
"destination_url": "xyz789",
"status": "xyz789",
"features": ["abc123"],
"moderation_status": "xyz789",
"file_size": 987.65,
"cost": 123.45,
"project": Project,
"objects": [ImageObject],
"tags": [ImageTag],
"metadata": ImageMetadata,
"moderation_nudity": [ImageModerationNudity],
"moderation_violence": [ImageModerationViolence]
}
}
}
get_link_preview
LinkPreview
| Name | Description |
|---|---|
url -
String!
|
The URL to fetch a preview for |
project_id -
String!
|
The project ID to bill for this query |
Example
Query
query get_link_preview($url: String!, $project_id: String!) {
get_link_preview(url: $url, project_id: $project_id) {
url
title
description
image
}
}
Variables
{"url": "xyz789", "project_id": "xyz789"}
Response
{
"data": {
"get_link_preview": {
"url": "xyz789",
"title": "abc123",
"description": "xyz789",
"image": "xyz789"
}
}
}
get_link_spam_score
Float
| Name | Description |
|---|---|
user_message -
String
|
Any user-provided message accompanying the link. Considered as a factor if provided (optional) |
user_id -
String
|
The ID (or hashed ID) of the user who shared this link. Considered as a factor if provided (optional) |
user_email_domain -
String
|
The email domain (or hashed email domain) of the user who shared this link. Considered as a factor if provided (optional) |
user_registration_date -
DateTime
|
The registration date of the user who shared this link. Considered as a factor if provided (optional). |
url -
String!
|
The URL to analyze |
project_id -
String!
|
The project ID to bill for this query |
Example
Query
query get_link_spam_score($user_message: String, $user_id: String, $user_email_domain: String, $user_registration_date: DateTime, $url: String!, $project_id: String!) {
get_link_spam_score(user_message: $user_message, user_id: $user_id, user_email_domain: $user_email_domain, user_registration_date: $user_registration_date, url: $url, project_id: $project_id)
}
Variables
{
"user_message": "abc123",
"user_id": "abc123",
"user_email_domain": "abc123",
"user_registration_date": DateTime,
"url": "abc123",
"project_id": "xyz789"
}
Response
{"data": {"get_link_spam_score": 123.45}}
get_livestream
Example
Query
query get_livestream($id: String!) {
get_livestream(id: $id) {
id
stream_key
project_id
is_broadcasting
created_at
project {
...ProjectFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"get_livestream": {
"id": "abc123",
"stream_key": "xyz789",
"project_id": "xyz789",
"is_broadcasting": false,
"created_at": DateTime,
"project": Project
}
}
}
get_livestream_asset
Example
Query
query get_livestream_asset($id: String!) {
get_livestream_asset(id: $id) {
id
livestream_id
is_active
duration
is_mp4_available
created_at
livestream {
...LivestreamFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"get_livestream_asset": {
"id": "xyz789",
"livestream_id": "xyz789",
"is_active": true,
"duration": 123.45,
"is_mp4_available": true,
"created_at": DateTime,
"livestream": Livestream
}
}
}
get_media_library
Example
Query
query get_media_library($id: String!) {
get_media_library(id: $id) {
id
created_at
updated_at
project_id
name
description
video_features
image_features
audio_features
project {
...ProjectFragment
}
assets {
...MediaLibraryAssetFragment
}
assetsCount
assetsSize
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"get_media_library": {
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "xyz789",
"name": "xyz789",
"description": "xyz789",
"video_features": ["xyz789"],
"image_features": ["abc123"],
"audio_features": ["abc123"],
"project": Project,
"assets": [MediaLibraryAsset],
"assetsCount": 123.45,
"assetsSize": 123.45
}
}
}
get_media_library_asset
Example
Query
query get_media_library_asset($id: String!) {
get_media_library_asset(id: $id) {
id
created_at
updated_at
media_library_id
name
content_type
original_size
filename
imageinsight_id
transcoding_id
captions_id
source_url
doc_extracted_text
saved_filename
mediaLibrary {
...MediaLibraryFragment
}
tags {
...MediaLibraryAssetTagFragment
}
imageinsight_job {
...ImageInsightJobFragment
}
transcoding_job {
...TranscodingJobFragment
}
captions {
...TranscriptionJobDetailFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"get_media_library_asset": {
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"media_library_id": "abc123",
"name": "xyz789",
"content_type": "abc123",
"original_size": 987.65,
"filename": "abc123",
"imageinsight_id": "abc123",
"transcoding_id": "xyz789",
"captions_id": "abc123",
"source_url": "abc123",
"doc_extracted_text": "xyz789",
"saved_filename": "abc123",
"mediaLibrary": MediaLibrary,
"tags": [MediaLibraryAssetTag],
"imageinsight_job": ImageInsightJob,
"transcoding_job": TranscodingJob,
"captions": TranscriptionJobDetail
}
}
}
get_project
Example
Query
query get_project($id: String!) {
get_project(id: $id) {
id
name
description
company_name
company_address
company_national_tax_id
created_at
updated_at
keys {
...ProjectKeyFragment
}
cdn_distributions {
...CDNDistributionFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"get_project": {
"id": "abc123",
"name": "abc123",
"description": "xyz789",
"company_name": "xyz789",
"company_address": "xyz789",
"company_national_tax_id": "xyz789",
"created_at": DateTime,
"updated_at": "abc123",
"keys": [ProjectKey],
"cdn_distributions": [CDNDistribution]
}
}
}
get_project_invoice
Invoice
| Name | Description |
|---|---|
month -
DateTime!
|
Month for which a invoice has to be returned |
project_id -
String!
|
Id of the project for which a particular invoice has to be returned |
Example
Query
query get_project_invoice($month: DateTime!, $project_id: String!) {
get_project_invoice(month: $month, project_id: $project_id) {
id
project_id
month
total_usd
status
due_date
invoice {
...InvoiceItemFragment
}
project {
...ProjectFragment
}
}
}
Variables
{"month": DateTime, "project_id": "abc123"}
Response
{
"data": {
"get_project_invoice": {
"id": "abc123",
"project_id": "xyz789",
"month": DateTime,
"total_usd": 123.45,
"status": "xyz789",
"due_date": "abc123",
"invoice": [InvoiceItem],
"project": Project
}
}
}
get_project_setting
Example
Query
query get_project_setting($setting_key: String!, $project_id: String!) {
get_project_setting(setting_key: $setting_key, project_id: $project_id) {
id
project_id
setting_key
value
project {
...ProjectFragment
}
}
}
Variables
{"setting_key": "xyz789", "project_id": "abc123"}
Response
{
"data": {
"get_project_setting": {
"id": "abc123",
"project_id": "abc123",
"setting_key": "abc123",
"value": "xyz789",
"project": Project
}
}
}
get_signed_url
String
| Name | Description |
|---|---|
expiry -
Float
|
The expiry for the short lived url |
bucket_path -
String!
|
The provider bucket path including key/filename |
bucket_name -
String!
|
The provider bucket name |
secret_key -
String!
|
The provider secret key |
access_key -
String!
|
The provider access key |
provider -
String!
|
The cloud provider |
Example
Query
query get_signed_url($expiry: Float, $bucket_path: String!, $bucket_name: String!, $secret_key: String!, $access_key: String!, $provider: String!) {
get_signed_url(expiry: $expiry, bucket_path: $bucket_path, bucket_name: $bucket_name, secret_key: $secret_key, access_key: $access_key, provider: $provider)
}
Variables
{
"expiry": 987.65,
"bucket_path": "xyz789",
"bucket_name": "xyz789",
"secret_key": "xyz789",
"access_key": "xyz789",
"provider": "xyz789"
}
Response
{"data": {"get_signed_url": "xyz789"}}
get_signed_url_for_media_library_asset
String
| Name | Description |
|---|---|
expiry -
Float
|
The expiry for the short lived url |
media_library_asset_id -
String!
|
The media library asset ID |
Example
Query
query get_signed_url_for_media_library_asset($expiry: Float, $media_library_asset_id: String!) {
get_signed_url_for_media_library_asset(expiry: $expiry, media_library_asset_id: $media_library_asset_id)
}
Variables
{"expiry": 987.65, "media_library_asset_id": "xyz789"}
Response
{"data": {"get_signed_url_for_media_library_asset": "abc123"}}
get_static_site
Example
Query
query get_static_site($id: String!) {
get_static_site(id: $id) {
id
created_at
updated_at
project_id
cdn_id
name
status
git_account_id
repo_name
repo_branch
build_command
project {
...ProjectFragment
}
cdn {
...CDNDistributionFragment
}
builds {
...StaticSiteBuildFragment
}
gitconnect {
...GitConnectFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"get_static_site": {
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"project_id": ID,
"cdn_id": "abc123",
"name": "xyz789",
"status": "abc123",
"git_account_id": "xyz789",
"repo_name": "abc123",
"repo_branch": "xyz789",
"build_command": "abc123",
"project": Project,
"cdn": CDNDistribution,
"builds": [StaticSiteBuild],
"gitconnect": GitConnect
}
}
}
get_static_site_build
Example
Query
query get_static_site_build($id: String!) {
get_static_site_build(id: $id) {
id
created_at
static_site_id
start_time
duration
end_time
status
logs
commit_url
static_site {
...StaticSiteFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"get_static_site_build": {
"id": ID,
"created_at": DateTime,
"static_site_id": ID,
"start_time": DateTime,
"duration": 123.45,
"end_time": DateTime,
"status": "abc123",
"logs": "xyz789",
"commit_url": "xyz789",
"static_site": StaticSite
}
}
}
get_transcoding_chart
[ChartData!]
| Name | Description |
|---|---|
end_date -
DateTime!
|
The end date till when fetch the jobs |
from_date -
DateTime!
|
The starting date from when to fetch the jobs |
project_id -
String!
|
ID of the project that owns the jobs |
Example
Query
query get_transcoding_chart($end_date: DateTime!, $from_date: DateTime!, $project_id: String!) {
get_transcoding_chart(end_date: $end_date, from_date: $from_date, project_id: $project_id) {
chargeable_time
created_at
}
}
Variables
{
"end_date": DateTime,
"from_date": DateTime,
"project_id": "abc123"
}
Response
{
"data": {
"get_transcoding_chart": [
{"chargeable_time": 123.45, "created_at": DateTime}
]
}
}
get_transcoding_job
Example
Query
query get_transcoding_job($id: String!) {
get_transcoding_job(id: $id) {
id
created_at
updated_at
project_id
source_url
source_provider
source_access_key
source_secret_key
source_bucket_name
source_bucket_path
destination_provider
destination_access_key
destination_secret_key
destination_bucket_name
destination_bucket_path
output_formats
webhook_url
status
error_message
chargeable_time
hls_url
mp4_url
mp3_url
thumbnail_url
source_file_size
hls_file_size
mp4_file_size
mp3_file_size
thumbnail_file_size
cost
source_format
total_number_of_jobs
project {
...ProjectFragment
}
milestones {
...TranscodingJobMilestoneFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"get_transcoding_job": {
"id": "xyz789",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "xyz789",
"source_url": "abc123",
"source_provider": "xyz789",
"source_access_key": "abc123",
"source_secret_key": "xyz789",
"source_bucket_name": "abc123",
"source_bucket_path": "abc123",
"destination_provider": "abc123",
"destination_access_key": "xyz789",
"destination_secret_key": "xyz789",
"destination_bucket_name": "xyz789",
"destination_bucket_path": "xyz789",
"output_formats": ["abc123"],
"webhook_url": "abc123",
"status": "abc123",
"error_message": "xyz789",
"chargeable_time": 987.65,
"hls_url": "xyz789",
"mp4_url": "xyz789",
"mp3_url": "xyz789",
"thumbnail_url": "xyz789",
"source_file_size": 987.65,
"hls_file_size": 987.65,
"mp4_file_size": 987.65,
"mp3_file_size": 987.65,
"thumbnail_file_size": 987.65,
"cost": 123.45,
"source_format": "xyz789",
"total_number_of_jobs": 987.65,
"project": Project,
"milestones": [TranscodingJobMilestone]
}
}
}
get_transcoding_stats
TranscodingStat
| Name | Description |
|---|---|
end_date -
DateTime!
|
End date for stats |
from_date -
DateTime!
|
Start date for stats |
project_id -
String!
|
ID of the project that owns the jobs |
Example
Query
query get_transcoding_stats($end_date: DateTime!, $from_date: DateTime!, $project_id: String!) {
get_transcoding_stats(end_date: $end_date, from_date: $from_date, project_id: $project_id) {
totalJobs
timeConsumed
successfulJobs
pendingJobs
totalSpending
}
}
Variables
{
"end_date": DateTime,
"from_date": DateTime,
"project_id": "abc123"
}
Response
{
"data": {
"get_transcoding_stats": {
"totalJobs": 123.45,
"timeConsumed": 123.45,
"successfulJobs": 987.65,
"pendingJobs": 123.45,
"totalSpending": 987.65
}
}
}
get_transcription_chart
[ChartData!]
| Name | Description |
|---|---|
end_date -
DateTime!
|
Ending date for stats |
from_date -
DateTime!
|
Starting date for stats |
project_id -
String!
|
ID of the project that owns the jobs |
Example
Query
query get_transcription_chart($end_date: DateTime!, $from_date: DateTime!, $project_id: String!) {
get_transcription_chart(end_date: $end_date, from_date: $from_date, project_id: $project_id) {
chargeable_time
created_at
}
}
Variables
{
"end_date": DateTime,
"from_date": DateTime,
"project_id": "abc123"
}
Response
{
"data": {
"get_transcription_chart": [
{"chargeable_time": 123.45, "created_at": DateTime}
]
}
}
get_transcription_job
Example
Query
query get_transcription_job($id: String!) {
get_transcription_job(id: $id) {
id
created_at
updated_at
project_id
source_url
destination_url
source_provider
source_access_key
source_secret_key
source_bucket_name
source_bucket_path
destination_provider
destination_access_key
destination_secret_key
destination_bucket_name
destination_bucket_path
webhook_url
status
chargeable_time
cost
total_number_of_jobs
captions {
...CaptionObjFragment
}
captionsVtt
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"get_transcription_job": {
"id": "xyz789",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "abc123",
"source_url": "xyz789",
"destination_url": "xyz789",
"source_provider": "abc123",
"source_access_key": "abc123",
"source_secret_key": "xyz789",
"source_bucket_name": "xyz789",
"source_bucket_path": "abc123",
"destination_provider": "abc123",
"destination_access_key": "abc123",
"destination_secret_key": "xyz789",
"destination_bucket_name": "xyz789",
"destination_bucket_path": "xyz789",
"webhook_url": "abc123",
"status": "xyz789",
"chargeable_time": 987.65,
"cost": 123.45,
"total_number_of_jobs": 987.65,
"captions": [CaptionObj],
"captionsVtt": "abc123"
}
}
}
get_transcription_job_caption
[CaptionObj!]
| Name | Description |
|---|---|
offset -
Float
|
|
limit -
Float
|
|
transcription_job_id -
String!
|
ID of the transcription job |
Example
Query
query get_transcription_job_caption($offset: Float, $limit: Float, $transcription_job_id: String!) {
get_transcription_job_caption(offset: $offset, limit: $limit, transcription_job_id: $transcription_job_id) {
text
start_time
end_time
}
}
Variables
{"offset": 123.45, "limit": 123.45, "transcription_job_id": "abc123"}
Response
{
"data": {
"get_transcription_job_caption": [
{"text": "abc123", "start_time": 987.65, "end_time": 123.45}
]
}
}
get_transcription_jobs_stat
TranscriptionJobStat
| Name | Description |
|---|---|
end_date -
DateTime!
|
Ending date for stats |
from_date -
DateTime!
|
Starting date for stats |
project_id -
String!
|
ID of the project that owns the jobs |
Example
Query
query get_transcription_jobs_stat($end_date: DateTime!, $from_date: DateTime!, $project_id: String!) {
get_transcription_jobs_stat(end_date: $end_date, from_date: $from_date, project_id: $project_id) {
totalJobs
timeConsumed
successfulJobs
pendingJobs
totalSpending
}
}
Variables
{
"end_date": DateTime,
"from_date": DateTime,
"project_id": "xyz789"
}
Response
{
"data": {
"get_transcription_jobs_stat": {
"totalJobs": 987.65,
"timeConsumed": 987.65,
"successfulJobs": 987.65,
"pendingJobs": 987.65,
"totalSpending": 123.45
}
}
}
get_upcoming_invoice
Invoice
| Name | Description |
|---|---|
project_id -
String!
|
Id of the project for which a particular invoice has to be returned |
Example
Query
query get_upcoming_invoice($project_id: String!) {
get_upcoming_invoice(project_id: $project_id) {
id
project_id
month
total_usd
status
due_date
invoice {
...InvoiceItemFragment
}
project {
...ProjectFragment
}
}
}
Variables
{"project_id": "abc123"}
Response
{
"data": {
"get_upcoming_invoice": {
"id": "abc123",
"project_id": "xyz789",
"month": DateTime,
"total_usd": 987.65,
"status": "xyz789",
"due_date": "abc123",
"invoice": [InvoiceItem],
"project": Project
}
}
}
get_user
Example
Query
query get_user($id: String!) {
get_user(id: $id) {
id
created_at
updated_at
first_name
last_name
email
phone
picture
verified
company
role
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"get_user": {
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"first_name": "abc123",
"last_name": "abc123",
"email": "yourname@example.com",
"phone": "xyz789",
"picture": "abc123",
"verified": true,
"company": "abc123",
"role": "xyz789"
}
}
}
get_video_insight_job
Example
Query
query get_video_insight_job($id: String!) {
get_video_insight_job(id: $id) {
id
created_at
updated_at
project_id
source_url
destination_url
source_provider
source_access_key
source_secret_key
source_bucket_name
source_bucket_path
destination_provider
destination_access_key
destination_secret_key
destination_bucket_name
destination_bucket_path
webhook_url
status
features
chargeable_time
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"get_video_insight_job": {
"id": "xyz789",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "abc123",
"source_url": "abc123",
"destination_url": "abc123",
"source_provider": "abc123",
"source_access_key": "xyz789",
"source_secret_key": "abc123",
"source_bucket_name": "xyz789",
"source_bucket_path": "abc123",
"destination_provider": "xyz789",
"destination_access_key": "abc123",
"destination_secret_key": "xyz789",
"destination_bucket_name": "abc123",
"destination_bucket_path": "xyz789",
"webhook_url": "xyz789",
"status": "xyz789",
"features": ["abc123"],
"chargeable_time": 987.65
}
}
}
get_website_analysis
Example
Query
query get_website_analysis($url: String!) {
get_website_analysis(url: $url) {
id
currentServiceUsed
title
description
link
}
}
Variables
{"url": "xyz789"}
Response
{
"data": {
"get_website_analysis": [
{
"id": "abc123",
"currentServiceUsed": "abc123",
"title": "abc123",
"description": "xyz789",
"link": "abc123"
}
]
}
}
list_backup_jobs
Example
Query
query list_backup_jobs($project_id: String!) {
list_backup_jobs(project_id: $project_id) {
id
project_id
origin_url
etag
size
project {
...ProjectFragment
}
}
}
Variables
{"project_id": "xyz789"}
Response
{
"data": {
"list_backup_jobs": [
{
"id": ID,
"project_id": "abc123",
"origin_url": "abc123",
"etag": "xyz789",
"size": 123.45,
"project": Project
}
]
}
}
list_cdn_custom_domains
Example
Query
query list_cdn_custom_domains($id: String!) {
list_cdn_custom_domains(id: $id) {
id
created_at
updated_at
cdn_id
domain
ssl
cdn {
...CDNDistributionFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"list_cdn_custom_domains": [
{
"id": "xyz789",
"created_at": DateTime,
"updated_at": DateTime,
"cdn_id": "abc123",
"domain": "xyz789",
"ssl": true,
"cdn": CDNDistribution
}
]
}
}
list_cdn_distributions
[CDNDistribution!]
| Name | Description |
|---|---|
project_id -
String!
|
Id of the project to which the cdn endpoint belongs |
Example
Query
query list_cdn_distributions($project_id: String!) {
list_cdn_distributions(project_id: $project_id) {
id
created_at
updated_at
project_id
bunny_cdn_id
endpoint
project {
...ProjectFragment
}
custom_domains {
...CDNCustomDomainFragment
}
}
}
Variables
{"project_id": "abc123"}
Response
{
"data": {
"list_cdn_distributions": [
{
"id": "xyz789",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "abc123",
"bunny_cdn_id": "xyz789",
"endpoint": "abc123",
"project": Project,
"custom_domains": [CDNCustomDomain]
}
]
}
}
list_cdn_statistics
CDNStatistics
| Name | Description |
|---|---|
to_date -
DateTime
|
The end date of the statistics. If no value is passed, the last 30 days will be returned. |
from_date -
DateTime
|
The start date of the statistics. If no value is passed, the last 30 days will be returned |
id -
String!
|
CDN distribution Id |
Example
Query
query list_cdn_statistics($to_date: DateTime, $from_date: DateTime, $id: String!) {
list_cdn_statistics(to_date: $to_date, from_date: $from_date, id: $id) {
id
total_bandwidth_used
total_origin_traffic
total_requests_served
cache_hit_rate
bandwidth_used_chart {
...BandwidthUsedChartFragment
}
}
}
Variables
{
"to_date": DateTime,
"from_date": DateTime,
"id": "abc123"
}
Response
{
"data": {
"list_cdn_statistics": {
"id": "xyz789",
"total_bandwidth_used": 123.45,
"total_origin_traffic": 123.45,
"total_requests_served": 123.45,
"cache_hit_rate": 987.65,
"bandwidth_used_chart": [BandwidthUsedChart]
}
}
}
list_file_conversion_jobs
[FileConversionJob!]
| Name | Description |
|---|---|
project_id -
String!
|
ID of the project that owns the jobs |
Example
Query
query list_file_conversion_jobs($project_id: String!) {
list_file_conversion_jobs(project_id: $project_id) {
id
created_at
updated_at
project_id
source_url
destination_url
output_format
webhook_url
status
error_message
chargeable_time
cost
original_size
converted_size
project {
...ProjectFragment
}
milestones {
...FileConversionJobMilestoneFragment
}
}
}
Variables
{"project_id": "xyz789"}
Response
{
"data": {
"list_file_conversion_jobs": [
{
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "abc123",
"source_url": "xyz789",
"destination_url": "xyz789",
"output_format": "abc123",
"webhook_url": "abc123",
"status": "abc123",
"error_message": "xyz789",
"chargeable_time": 123.45,
"cost": 123.45,
"original_size": 123.45,
"converted_size": 123.45,
"project": Project,
"milestones": [FileConversionJobMilestone]
}
]
}
}
list_image_insight_jobs
[ImageInsightJob!]
| Name | Description |
|---|---|
project_id -
String!
|
ID of the project that owns the jobs |
Example
Query
query list_image_insight_jobs($project_id: String!) {
list_image_insight_jobs(project_id: $project_id) {
id
created_at
project_id
source_url
destination_url
status
features
moderation_status
file_size
cost
project {
...ProjectFragment
}
objects {
...ImageObjectFragment
}
tags {
...ImageTagFragment
}
metadata {
...ImageMetadataFragment
}
moderation_nudity {
...ImageModerationNudityFragment
}
moderation_violence {
...ImageModerationViolenceFragment
}
}
}
Variables
{"project_id": "abc123"}
Response
{
"data": {
"list_image_insight_jobs": [
{
"id": "xyz789",
"created_at": DateTime,
"project_id": "abc123",
"source_url": "xyz789",
"destination_url": "abc123",
"status": "abc123",
"features": ["xyz789"],
"moderation_status": "abc123",
"file_size": 123.45,
"cost": 123.45,
"project": Project,
"objects": [ImageObject],
"tags": [ImageTag],
"metadata": ImageMetadata,
"moderation_nudity": [ImageModerationNudity],
"moderation_violence": [ImageModerationViolence]
}
]
}
}
list_livestream_assets
Example
Query
query list_livestream_assets($livestream_id: String!) {
list_livestream_assets(livestream_id: $livestream_id) {
id
livestream_id
is_active
duration
is_mp4_available
created_at
livestream {
...LivestreamFragment
}
}
}
Variables
{"livestream_id": "xyz789"}
Response
{
"data": {
"list_livestream_assets": [
{
"id": "abc123",
"livestream_id": "abc123",
"is_active": true,
"duration": 987.65,
"is_mp4_available": true,
"created_at": DateTime,
"livestream": Livestream
}
]
}
}
list_livestreams
Example
Query
query list_livestreams($project_id: String!) {
list_livestreams(project_id: $project_id) {
id
stream_key
project_id
is_broadcasting
created_at
project {
...ProjectFragment
}
}
}
Variables
{"project_id": "abc123"}
Response
{
"data": {
"list_livestreams": [
{
"id": "abc123",
"stream_key": "abc123",
"project_id": "xyz789",
"is_broadcasting": true,
"created_at": DateTime,
"project": Project
}
]
}
}
list_media_libraries
Example
Query
query list_media_libraries($project_id: String!) {
list_media_libraries(project_id: $project_id) {
id
created_at
updated_at
project_id
name
description
video_features
image_features
audio_features
project {
...ProjectFragment
}
assets {
...MediaLibraryAssetFragment
}
assetsCount
assetsSize
}
}
Variables
{"project_id": "abc123"}
Response
{
"data": {
"list_media_libraries": [
{
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "abc123",
"name": "xyz789",
"description": "abc123",
"video_features": ["xyz789"],
"image_features": ["abc123"],
"audio_features": ["abc123"],
"project": Project,
"assets": [MediaLibraryAsset],
"assetsCount": 123.45,
"assetsSize": 123.45
}
]
}
}
list_media_library_assets
Example
Query
query list_media_library_assets($media_library_id: String!) {
list_media_library_assets(media_library_id: $media_library_id) {
id
created_at
updated_at
media_library_id
name
content_type
original_size
filename
imageinsight_id
transcoding_id
captions_id
source_url
doc_extracted_text
saved_filename
mediaLibrary {
...MediaLibraryFragment
}
tags {
...MediaLibraryAssetTagFragment
}
imageinsight_job {
...ImageInsightJobFragment
}
transcoding_job {
...TranscodingJobFragment
}
captions {
...TranscriptionJobDetailFragment
}
}
}
Variables
{"media_library_id": "abc123"}
Response
{
"data": {
"list_media_library_assets": [
{
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"media_library_id": "xyz789",
"name": "abc123",
"content_type": "xyz789",
"original_size": 987.65,
"filename": "xyz789",
"imageinsight_id": "abc123",
"transcoding_id": "xyz789",
"captions_id": "abc123",
"source_url": "xyz789",
"doc_extracted_text": "xyz789",
"saved_filename": "abc123",
"mediaLibrary": MediaLibrary,
"tags": [MediaLibraryAssetTag],
"imageinsight_job": ImageInsightJob,
"transcoding_job": TranscodingJob,
"captions": TranscriptionJobDetail
}
]
}
}
list_project_charges
[AggregateCharge!]!
| Name | Description |
|---|---|
service_id -
String
|
ID of the service, e.g, LINK_PREVIEW or IMAGE_INTELLIGENCE_REQUEST |
interval -
String
|
Interval (month or week or day). Default = "day" |
end_date -
DateTime!
|
End Date |
start_date -
DateTime!
|
Start Date |
project_id -
String!
|
Id of the project using the service |
Example
Query
query list_project_charges($service_id: String, $interval: String, $end_date: DateTime!, $start_date: DateTime!, $project_id: String!) {
list_project_charges(service_id: $service_id, interval: $interval, end_date: $end_date, start_date: $start_date, project_id: $project_id) {
period
total_units
total_cost
service
}
}
Variables
{
"service_id": "abc123",
"interval": "day",
"end_date": DateTime,
"start_date": DateTime,
"project_id": "xyz789"
}
Response
{
"data": {
"list_project_charges": [
{
"period": DateTime,
"total_units": 123,
"total_cost": 123.45,
"service": "xyz789"
}
]
}
}
list_project_invoice_items
[InvoiceItem!]
| Name | Description |
|---|---|
month -
DateTime!
|
Month for which a invoice item has to be returned |
project_id -
String!
|
Id of the project for which a particular invoice item has to be returned |
Example
Query
query list_project_invoice_items($month: DateTime!, $project_id: String!) {
list_project_invoice_items(month: $month, project_id: $project_id) {
id
project_id
month
billing_sku_id
billing_sku_name
billing_sku_category
service
total_units
price_per_unit
}
}
Variables
{"month": DateTime, "project_id": "abc123"}
Response
{
"data": {
"list_project_invoice_items": [
{
"id": "xyz789",
"project_id": "xyz789",
"month": DateTime,
"billing_sku_id": "abc123",
"billing_sku_name": "xyz789",
"billing_sku_category": "abc123",
"service": "xyz789",
"total_units": 123,
"price_per_unit": 123.45
}
]
}
}
list_project_invoices
[Invoice!]
| Name | Description |
|---|---|
project_id -
String!
|
Id of the project for which the list of invoices has to be returned |
Example
Query
query list_project_invoices($project_id: String!) {
list_project_invoices(project_id: $project_id) {
id
project_id
month
total_usd
status
due_date
invoice {
...InvoiceItemFragment
}
project {
...ProjectFragment
}
}
}
Variables
{"project_id": "xyz789"}
Response
{
"data": {
"list_project_invoices": [
{
"id": "abc123",
"project_id": "xyz789",
"month": DateTime,
"total_usd": 123.45,
"status": "xyz789",
"due_date": "abc123",
"invoice": [InvoiceItem],
"project": Project
}
]
}
}
list_project_keys
Example
Query
query list_project_keys($project_id: String!) {
list_project_keys(project_id: $project_id) {
id
created_at
updated_at
project_id
role
name
description
last_accessed
secret
project {
...ProjectFragment
}
}
}
Variables
{"project_id": "abc123"}
Response
{
"data": {
"list_project_keys": [
{
"id": "xyz789",
"created_at": DateTime,
"updated_at": "abc123",
"project_id": "xyz789",
"role": "xyz789",
"name": "xyz789",
"description": "abc123",
"last_accessed": "xyz789",
"secret": "abc123",
"project": Project
}
]
}
}
list_project_members
Example
Query
query list_project_members($project_id: String!) {
list_project_members(project_id: $project_id) {
id
created_at
updated_at
user_id
project_id
role
project {
...ProjectFragment
}
user {
...UserFragment
}
}
}
Variables
{"project_id": "abc123"}
Response
{
"data": {
"list_project_members": [
{
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"user_id": "abc123",
"project_id": "abc123",
"role": "xyz789",
"project": Project,
"user": User
}
]
}
}
list_repos
Example
Query
query list_repos($git_account_id: String!) {
list_repos(git_account_id: $git_account_id)
}
Variables
{"git_account_id": "xyz789"}
Response
{"data": {"list_repos": ["abc123"]}}
list_static_site_builds
Example
Query
query list_static_site_builds($static_site_id: String!) {
list_static_site_builds(static_site_id: $static_site_id) {
id
created_at
static_site_id
start_time
duration
end_time
status
logs
commit_url
static_site {
...StaticSiteFragment
}
}
}
Variables
{"static_site_id": "xyz789"}
Response
{
"data": {
"list_static_site_builds": [
{
"id": ID,
"created_at": DateTime,
"static_site_id": ID,
"start_time": DateTime,
"duration": 123.45,
"end_time": DateTime,
"status": "abc123",
"logs": "xyz789",
"commit_url": "abc123",
"static_site": StaticSite
}
]
}
}
list_static_sites
Example
Query
query list_static_sites($project_id: String!) {
list_static_sites(project_id: $project_id) {
id
created_at
updated_at
project_id
cdn_id
name
status
git_account_id
repo_name
repo_branch
build_command
project {
...ProjectFragment
}
cdn {
...CDNDistributionFragment
}
builds {
...StaticSiteBuildFragment
}
gitconnect {
...GitConnectFragment
}
}
}
Variables
{"project_id": "abc123"}
Response
{
"data": {
"list_static_sites": [
{
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"project_id": ID,
"cdn_id": "xyz789",
"name": "xyz789",
"status": "abc123",
"git_account_id": "abc123",
"repo_name": "abc123",
"repo_branch": "abc123",
"build_command": "xyz789",
"project": Project,
"cdn": CDNDistribution,
"builds": [StaticSiteBuild],
"gitconnect": GitConnect
}
]
}
}
list_transcoding_jobs
[TranscodingJob!]
| Name | Description |
|---|---|
offset -
Float
|
|
limit -
Float
|
|
project_id -
String!
|
ID of the project that owns the jobs |
Example
Query
query list_transcoding_jobs($offset: Float, $limit: Float, $project_id: String!) {
list_transcoding_jobs(offset: $offset, limit: $limit, project_id: $project_id) {
id
created_at
updated_at
project_id
source_url
source_provider
source_access_key
source_secret_key
source_bucket_name
source_bucket_path
destination_provider
destination_access_key
destination_secret_key
destination_bucket_name
destination_bucket_path
output_formats
webhook_url
status
error_message
chargeable_time
hls_url
mp4_url
mp3_url
thumbnail_url
source_file_size
hls_file_size
mp4_file_size
mp3_file_size
thumbnail_file_size
cost
source_format
total_number_of_jobs
project {
...ProjectFragment
}
milestones {
...TranscodingJobMilestoneFragment
}
}
}
Variables
{"offset": 123.45, "limit": 987.65, "project_id": "abc123"}
Response
{
"data": {
"list_transcoding_jobs": [
{
"id": "xyz789",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "abc123",
"source_url": "xyz789",
"source_provider": "abc123",
"source_access_key": "abc123",
"source_secret_key": "abc123",
"source_bucket_name": "abc123",
"source_bucket_path": "abc123",
"destination_provider": "abc123",
"destination_access_key": "xyz789",
"destination_secret_key": "xyz789",
"destination_bucket_name": "abc123",
"destination_bucket_path": "abc123",
"output_formats": ["xyz789"],
"webhook_url": "abc123",
"status": "xyz789",
"error_message": "xyz789",
"chargeable_time": 123.45,
"hls_url": "abc123",
"mp4_url": "abc123",
"mp3_url": "abc123",
"thumbnail_url": "abc123",
"source_file_size": 987.65,
"hls_file_size": 123.45,
"mp4_file_size": 123.45,
"mp3_file_size": 987.65,
"thumbnail_file_size": 987.65,
"cost": 123.45,
"source_format": "xyz789",
"total_number_of_jobs": 123.45,
"project": Project,
"milestones": [TranscodingJobMilestone]
}
]
}
}
list_transcription_jobs
[TranscriptionJob!]
| Name | Description |
|---|---|
offset -
Float
|
|
limit -
Float
|
|
project_id -
String!
|
ID of the project that owns the jobs |
Example
Query
query list_transcription_jobs($offset: Float, $limit: Float, $project_id: String!) {
list_transcription_jobs(offset: $offset, limit: $limit, project_id: $project_id) {
id
created_at
updated_at
project_id
source_url
destination_url
source_provider
source_access_key
source_secret_key
source_bucket_name
source_bucket_path
destination_provider
destination_access_key
destination_secret_key
destination_bucket_name
destination_bucket_path
webhook_url
status
chargeable_time
cost
total_number_of_jobs
}
}
Variables
{"offset": 123.45, "limit": 987.65, "project_id": "xyz789"}
Response
{
"data": {
"list_transcription_jobs": [
{
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "xyz789",
"source_url": "abc123",
"destination_url": "xyz789",
"source_provider": "abc123",
"source_access_key": "abc123",
"source_secret_key": "abc123",
"source_bucket_name": "xyz789",
"source_bucket_path": "xyz789",
"destination_provider": "abc123",
"destination_access_key": "xyz789",
"destination_secret_key": "xyz789",
"destination_bucket_name": "abc123",
"destination_bucket_path": "abc123",
"webhook_url": "abc123",
"status": "abc123",
"chargeable_time": 987.65,
"cost": 987.65,
"total_number_of_jobs": 123.45
}
]
}
}
list_user_projects
Example
Query
query list_user_projects($user_id: String!) {
list_user_projects(user_id: $user_id) {
id
created_at
updated_at
user_id
project_id
role
project {
...ProjectFragment
}
user {
...UserFragment
}
}
}
Variables
{"user_id": "xyz789"}
Response
{
"data": {
"list_user_projects": [
{
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"user_id": "xyz789",
"project_id": "xyz789",
"role": "abc123",
"project": Project,
"user": User
}
]
}
}
list_video_insight
Example
Query
query list_video_insight($project_id: String!) {
list_video_insight(project_id: $project_id) {
id
created_at
updated_at
project_id
source_url
destination_url
source_provider
source_access_key
source_secret_key
source_bucket_name
source_bucket_path
destination_provider
destination_access_key
destination_secret_key
destination_bucket_name
destination_bucket_path
webhook_url
status
features
chargeable_time
}
}
Variables
{"project_id": "xyz789"}
Response
{
"data": {
"list_video_insight": [
{
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "abc123",
"source_url": "xyz789",
"destination_url": "abc123",
"source_provider": "xyz789",
"source_access_key": "xyz789",
"source_secret_key": "abc123",
"source_bucket_name": "abc123",
"source_bucket_path": "abc123",
"destination_provider": "abc123",
"destination_access_key": "xyz789",
"destination_secret_key": "abc123",
"destination_bucket_name": "xyz789",
"destination_bucket_path": "abc123",
"webhook_url": "abc123",
"status": "xyz789",
"features": ["xyz789"],
"chargeable_time": 987.65
}
]
}
}
login
String!
| Name | Description |
|---|---|
password -
String!
|
The password of user |
email -
String!
|
The email address of user |
Example
Query
query login($password: String!, $email: String!) {
login(password: $password, email: $email)
}
Variables
{
"password": "xyz789",
"email": "yourname@example.com"
}
Response
{"data": {"login": "abc123"}}
resend_email_project_member
Example
Query
query resend_email_project_member($project_member_id: String!) {
resend_email_project_member(project_member_id: $project_member_id)
}
Variables
{"project_member_id": "xyz789"}
Response
{"data": {"resend_email_project_member": true}}
Mutations
add_card
Boolean!
| Name | Description |
|---|---|
state -
String
|
state of the customer |
city -
String
|
city of the customer |
postal_code -
String
|
postal code of the customer |
country -
String
|
country of the customer |
line2 -
String
|
line2 address of the customer |
line1 -
String
|
line1 address of the customer |
name -
String
|
name of the customer |
cvv -
String
|
cvv from card |
exp_year -
Float!
|
Year of expiry |
exp_month -
Float!
|
Month of expiry |
card_number -
String!
|
card number |
project_id -
String!
|
Id of the project using the service |
Example
Query
mutation add_card($state: String, $city: String, $postal_code: String, $country: String, $line2: String, $line1: String, $name: String, $cvv: String, $exp_year: Float!, $exp_month: Float!, $card_number: String!, $project_id: String!) {
add_card(state: $state, city: $city, postal_code: $postal_code, country: $country, line2: $line2, line1: $line1, name: $name, cvv: $cvv, exp_year: $exp_year, exp_month: $exp_month, card_number: $card_number, project_id: $project_id)
}
Variables
{
"state": "abc123",
"city": "xyz789",
"postal_code": "xyz789",
"country": "abc123",
"line2": "xyz789",
"line1": "xyz789",
"name": "xyz789",
"cvv": "xyz789",
"exp_year": 987.65,
"exp_month": 987.65,
"card_number": "xyz789",
"project_id": "xyz789"
}
Response
{"data": {"add_card": true}}
create_backup_job
Boolean!
| Name | Description |
|---|---|
size -
Float!
|
|
etag -
String!
|
|
created_at -
String!
|
|
origin_url -
String!
|
Example
Query
mutation create_backup_job($size: Float!, $etag: String!, $created_at: String!, $origin_url: String!) {
create_backup_job(size: $size, etag: $etag, created_at: $created_at, origin_url: $origin_url)
}
Variables
{
"size": 123.45,
"etag": "abc123",
"created_at": "xyz789",
"origin_url": "abc123"
}
Response
{"data": {"create_backup_job": false}}
create_cdn_distribution
CDNDistribution
| Name | Description |
|---|---|
endpoint -
String!
|
Storage bucket endpoint |
project_id -
String!
|
Id of the project to which the cdn endpoint belongs |
Example
Query
mutation create_cdn_distribution($endpoint: String!, $project_id: String!) {
create_cdn_distribution(endpoint: $endpoint, project_id: $project_id) {
id
created_at
updated_at
project_id
bunny_cdn_id
endpoint
project {
...ProjectFragment
}
custom_domains {
...CDNCustomDomainFragment
}
}
}
Variables
{"endpoint": "abc123", "project_id": "xyz789"}
Response
{
"data": {
"create_cdn_distribution": {
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "xyz789",
"bunny_cdn_id": "xyz789",
"endpoint": "abc123",
"project": Project,
"custom_domains": [CDNCustomDomain]
}
}
}
create_file_conversion_job
FileConversionJob
| Name | Description |
|---|---|
webhook_url -
String
|
An optional webhook to receive updates on this job |
output_format -
String!
|
The output format of the file conversion job |
destination_bucket_path -
String
|
The destination provider bucket path |
destination_bucket_name -
String
|
The destination provider bucket name |
destination_secret_key -
String
|
The destination provider secret key |
destination_access_key -
String
|
The destination provider access key |
destination_provider -
String
|
The destination provider to save the file conversion file |
source_bucket_path -
String
|
The source provider bucket path |
source_bucket_name -
String
|
The source provider bucket name |
source_secret_key -
String
|
The source provider secret key |
source_access_key -
String
|
The source provider access key |
source_url -
String
|
The source URL of the file if source provider is URL |
source_provider -
String!
|
The source provider of the file for file conversion job |
project_id -
String!
|
ID of the project that owns the job |
Example
Query
mutation create_file_conversion_job($webhook_url: String, $output_format: String!, $destination_bucket_path: String, $destination_bucket_name: String, $destination_secret_key: String, $destination_access_key: String, $destination_provider: String, $source_bucket_path: String, $source_bucket_name: String, $source_secret_key: String, $source_access_key: String, $source_url: String, $source_provider: String!, $project_id: String!) {
create_file_conversion_job(webhook_url: $webhook_url, output_format: $output_format, destination_bucket_path: $destination_bucket_path, destination_bucket_name: $destination_bucket_name, destination_secret_key: $destination_secret_key, destination_access_key: $destination_access_key, destination_provider: $destination_provider, source_bucket_path: $source_bucket_path, source_bucket_name: $source_bucket_name, source_secret_key: $source_secret_key, source_access_key: $source_access_key, source_url: $source_url, source_provider: $source_provider, project_id: $project_id) {
id
created_at
updated_at
project_id
source_url
destination_url
output_format
webhook_url
status
error_message
chargeable_time
cost
original_size
converted_size
project {
...ProjectFragment
}
milestones {
...FileConversionJobMilestoneFragment
}
}
}
Variables
{
"webhook_url": "xyz789",
"output_format": "xyz789",
"destination_bucket_path": "xyz789",
"destination_bucket_name": "abc123",
"destination_secret_key": "xyz789",
"destination_access_key": "xyz789",
"destination_provider": "xyz789",
"source_bucket_path": "abc123",
"source_bucket_name": "abc123",
"source_secret_key": "abc123",
"source_access_key": "abc123",
"source_url": "xyz789",
"source_provider": "abc123",
"project_id": "xyz789"
}
Response
{
"data": {
"create_file_conversion_job": {
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "abc123",
"source_url": "xyz789",
"destination_url": "xyz789",
"output_format": "abc123",
"webhook_url": "abc123",
"status": "abc123",
"error_message": "xyz789",
"chargeable_time": 987.65,
"cost": 123.45,
"original_size": 987.65,
"converted_size": 987.65,
"project": Project,
"milestones": [FileConversionJobMilestone]
}
}
}
create_image_insight_job
ImageInsightJob
| Name | Description |
|---|---|
features -
[String!]!
|
The features provided by the Image Insights Service. It accepts following features: image-moderation, labels, ocr, object-detection, metadata |
min_confidence -
Float
|
The minimum confidence. Default = 60 |
destination_bucket_path -
String
|
The destination provider bucket path |
destination_bucket_name -
String
|
The destination provider bucket name |
destination_secret_key -
String
|
The destination provider secret key |
destination_access_key -
String
|
The destination provider access key |
destination_provider -
String
|
The destination provider to save the image insight file |
source_bucket_path -
String
|
The source provider bucket path |
source_bucket_name -
String
|
The source provider bucket name |
source_secret_key -
String
|
The source provider secret key |
source_access_key -
String
|
The source provider access key |
source_url -
String
|
The source URL of the file if source provider is URL |
source_provider -
String!
|
The source provider of the file for image insight job |
project_id -
String!
|
The project ID |
Example
Query
mutation create_image_insight_job($features: [String!]!, $min_confidence: Float, $destination_bucket_path: String, $destination_bucket_name: String, $destination_secret_key: String, $destination_access_key: String, $destination_provider: String, $source_bucket_path: String, $source_bucket_name: String, $source_secret_key: String, $source_access_key: String, $source_url: String, $source_provider: String!, $project_id: String!) {
create_image_insight_job(features: $features, min_confidence: $min_confidence, destination_bucket_path: $destination_bucket_path, destination_bucket_name: $destination_bucket_name, destination_secret_key: $destination_secret_key, destination_access_key: $destination_access_key, destination_provider: $destination_provider, source_bucket_path: $source_bucket_path, source_bucket_name: $source_bucket_name, source_secret_key: $source_secret_key, source_access_key: $source_access_key, source_url: $source_url, source_provider: $source_provider, project_id: $project_id) {
id
created_at
project_id
source_url
destination_url
status
features
moderation_status
file_size
cost
project {
...ProjectFragment
}
objects {
...ImageObjectFragment
}
tags {
...ImageTagFragment
}
metadata {
...ImageMetadataFragment
}
moderation_nudity {
...ImageModerationNudityFragment
}
moderation_violence {
...ImageModerationViolenceFragment
}
}
}
Variables
{
"features": ["abc123"],
"min_confidence": 60,
"destination_bucket_path": "xyz789",
"destination_bucket_name": "xyz789",
"destination_secret_key": "abc123",
"destination_access_key": "xyz789",
"destination_provider": "xyz789",
"source_bucket_path": "xyz789",
"source_bucket_name": "abc123",
"source_secret_key": "abc123",
"source_access_key": "xyz789",
"source_url": "abc123",
"source_provider": "abc123",
"project_id": "abc123"
}
Response
{
"data": {
"create_image_insight_job": {
"id": "abc123",
"created_at": DateTime,
"project_id": "abc123",
"source_url": "abc123",
"destination_url": "abc123",
"status": "xyz789",
"features": ["abc123"],
"moderation_status": "xyz789",
"file_size": 123.45,
"cost": 987.65,
"project": Project,
"objects": [ImageObject],
"tags": [ImageTag],
"metadata": ImageMetadata,
"moderation_nudity": [ImageModerationNudity],
"moderation_violence": [ImageModerationViolence]
}
}
}
create_livestream
Example
Query
mutation create_livestream($project_id: String!) {
create_livestream(project_id: $project_id) {
id
stream_key
project_id
is_broadcasting
created_at
project {
...ProjectFragment
}
}
}
Variables
{"project_id": "xyz789"}
Response
{
"data": {
"create_livestream": {
"id": "abc123",
"stream_key": "xyz789",
"project_id": "abc123",
"is_broadcasting": false,
"created_at": DateTime,
"project": Project
}
}
}
create_media_library
MediaLibrary!
| Name | Description |
|---|---|
audio_features -
[String!]
|
The audio features selected to apply on all uploaded audio files of the media library |
image_features -
[String!]
|
The image features selected to apply on all uploaded images of the media library |
video_features -
[String!]
|
The video features selected to apply on all uploaded videos of the media library |
description -
String
|
An optional description for the media library |
name -
String!
|
A user-provided name for the media library |
project_id -
String!
|
The project ID |
Example
Query
mutation create_media_library($audio_features: [String!], $image_features: [String!], $video_features: [String!], $description: String, $name: String!, $project_id: String!) {
create_media_library(audio_features: $audio_features, image_features: $image_features, video_features: $video_features, description: $description, name: $name, project_id: $project_id) {
id
created_at
updated_at
project_id
name
description
video_features
image_features
audio_features
project {
...ProjectFragment
}
assets {
...MediaLibraryAssetFragment
}
assetsCount
assetsSize
}
}
Variables
{
"audio_features": ["xyz789"],
"image_features": ["abc123"],
"video_features": ["abc123"],
"description": "xyz789",
"name": "abc123",
"project_id": "abc123"
}
Response
{
"data": {
"create_media_library": {
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "xyz789",
"name": "xyz789",
"description": "abc123",
"video_features": ["xyz789"],
"image_features": ["xyz789"],
"audio_features": ["abc123"],
"project": Project,
"assets": [MediaLibraryAsset],
"assetsCount": 123.45,
"assetsSize": 987.65
}
}
}
create_project
Project!
| Name | Description |
|---|---|
company_national_tax_id -
String!
|
The national tax ID of the company |
company_address -
String!
|
The address of the company |
company_name -
String!
|
The name of the company |
description -
String
|
The description for the project |
name -
String!
|
The project name |
Example
Query
mutation create_project($company_national_tax_id: String!, $company_address: String!, $company_name: String!, $description: String, $name: String!) {
create_project(company_national_tax_id: $company_national_tax_id, company_address: $company_address, company_name: $company_name, description: $description, name: $name) {
id
name
description
company_name
company_address
company_national_tax_id
created_at
updated_at
keys {
...ProjectKeyFragment
}
cdn_distributions {
...CDNDistributionFragment
}
}
}
Variables
{
"company_national_tax_id": "xyz789",
"company_address": "abc123",
"company_name": "xyz789",
"description": "xyz789",
"name": "abc123"
}
Response
{
"data": {
"create_project": {
"id": "xyz789",
"name": "abc123",
"description": "abc123",
"company_name": "xyz789",
"company_address": "xyz789",
"company_national_tax_id": "abc123",
"created_at": DateTime,
"updated_at": "abc123",
"keys": [ProjectKey],
"cdn_distributions": [CDNDistribution]
}
}
}
create_project_key
ProjectKey!
| Name | Description |
|---|---|
description -
String
|
The description for the project key |
name -
String!
|
A name for the project key |
role -
String!
|
Role to assign the key, can be either READWRITE or READ |
project_id -
String!
|
The project ID |
Example
Query
mutation create_project_key($description: String, $name: String!, $role: String!, $project_id: String!) {
create_project_key(description: $description, name: $name, role: $role, project_id: $project_id) {
id
created_at
updated_at
project_id
role
name
description
last_accessed
secret
project {
...ProjectFragment
}
}
}
Variables
{
"description": "abc123",
"name": "abc123",
"role": "abc123",
"project_id": "xyz789"
}
Response
{
"data": {
"create_project_key": {
"id": "xyz789",
"created_at": DateTime,
"updated_at": "abc123",
"project_id": "xyz789",
"role": "xyz789",
"name": "xyz789",
"description": "abc123",
"last_accessed": "xyz789",
"secret": "abc123",
"project": Project
}
}
}
create_project_member
ProjectMember!
| Name | Description |
|---|---|
role -
String!
|
Role to assign the user, can be either ADMIN, READWRITE or READ |
email -
String!
|
The email address of member |
project_id -
String!
|
The project ID |
Example
Query
mutation create_project_member($role: String!, $email: String!, $project_id: String!) {
create_project_member(role: $role, email: $email, project_id: $project_id) {
id
created_at
updated_at
user_id
project_id
role
project {
...ProjectFragment
}
user {
...UserFragment
}
}
}
Variables
{"role": "abc123", "email": "xyz789", "project_id": "abc123"}
Response
{
"data": {
"create_project_member": {
"id": "xyz789",
"created_at": DateTime,
"updated_at": DateTime,
"user_id": "abc123",
"project_id": "abc123",
"role": "abc123",
"project": Project,
"user": User
}
}
}
create_project_setting
ProjectSetting
| Name | Description |
|---|---|
value -
String!
|
|
setting_key -
String!
|
|
project_id -
String!
|
Example
Query
mutation create_project_setting($value: String!, $setting_key: String!, $project_id: String!) {
create_project_setting(value: $value, setting_key: $setting_key, project_id: $project_id) {
id
project_id
setting_key
value
project {
...ProjectFragment
}
}
}
Variables
{"value": "abc123", "setting_key": "xyz789", "project_id": "xyz789"}
Response
{
"data": {
"create_project_setting": {
"id": "abc123",
"project_id": "abc123",
"setting_key": "abc123",
"value": "xyz789",
"project": Project
}
}
}
create_static_site
StaticSite!
| Name | Description |
|---|---|
build_command -
String
|
The build command provided by user |
repo_branch -
String!
|
The branch to deploy |
repo_name -
String!
|
The full name of the repo, e.g. csuitecircle/somerepo |
git_account_id -
String!
|
The ID of the git account used to pull source code |
name -
String!
|
The name of the site |
project_id -
String!
|
The project that will own the site |
Example
Query
mutation create_static_site($build_command: String, $repo_branch: String!, $repo_name: String!, $git_account_id: String!, $name: String!, $project_id: String!) {
create_static_site(build_command: $build_command, repo_branch: $repo_branch, repo_name: $repo_name, git_account_id: $git_account_id, name: $name, project_id: $project_id) {
id
created_at
updated_at
project_id
cdn_id
name
status
git_account_id
repo_name
repo_branch
build_command
project {
...ProjectFragment
}
cdn {
...CDNDistributionFragment
}
builds {
...StaticSiteBuildFragment
}
gitconnect {
...GitConnectFragment
}
}
}
Variables
{
"build_command": "abc123",
"repo_branch": "abc123",
"repo_name": "xyz789",
"git_account_id": "xyz789",
"name": "abc123",
"project_id": "abc123"
}
Response
{
"data": {
"create_static_site": {
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"project_id": ID,
"cdn_id": "abc123",
"name": "xyz789",
"status": "abc123",
"git_account_id": "abc123",
"repo_name": "xyz789",
"repo_branch": "abc123",
"build_command": "xyz789",
"project": Project,
"cdn": CDNDistribution,
"builds": [StaticSiteBuild],
"gitconnect": GitConnect
}
}
}
create_transcoding_job
TranscodingJob
| Name | Description |
|---|---|
webhook_url -
String
|
An optional webhook to receive updates on this job |
output_formats -
[String!]!
|
The output formats of the transcoding job |
destination_bucket_path -
String
|
The destination provider bucket path |
destination_bucket_name -
String
|
The destination provider bucket name |
destination_secret_key -
String
|
The destination provider secret key |
destination_access_key -
String
|
The destination provider access key |
destination_provider -
String!
|
The destination provider to save the transcoded file, must not be URL |
source_bucket_path -
String
|
The source provider bucket path |
source_bucket_name -
String
|
The source provider bucket name |
source_secret_key -
String
|
The source provider secret key |
source_access_key -
String
|
The source provider access key |
source_url -
String
|
The source URL of the file if source provider is URL |
source_provider -
String!
|
The source provider of the file for transcoding job |
project_id -
String!
|
ID of the project that owns the job |
Example
Query
mutation create_transcoding_job($webhook_url: String, $output_formats: [String!]!, $destination_bucket_path: String, $destination_bucket_name: String, $destination_secret_key: String, $destination_access_key: String, $destination_provider: String!, $source_bucket_path: String, $source_bucket_name: String, $source_secret_key: String, $source_access_key: String, $source_url: String, $source_provider: String!, $project_id: String!) {
create_transcoding_job(webhook_url: $webhook_url, output_formats: $output_formats, destination_bucket_path: $destination_bucket_path, destination_bucket_name: $destination_bucket_name, destination_secret_key: $destination_secret_key, destination_access_key: $destination_access_key, destination_provider: $destination_provider, source_bucket_path: $source_bucket_path, source_bucket_name: $source_bucket_name, source_secret_key: $source_secret_key, source_access_key: $source_access_key, source_url: $source_url, source_provider: $source_provider, project_id: $project_id) {
id
created_at
updated_at
project_id
source_url
source_provider
source_access_key
source_secret_key
source_bucket_name
source_bucket_path
destination_provider
destination_access_key
destination_secret_key
destination_bucket_name
destination_bucket_path
output_formats
webhook_url
status
error_message
chargeable_time
hls_url
mp4_url
mp3_url
thumbnail_url
source_file_size
hls_file_size
mp4_file_size
mp3_file_size
thumbnail_file_size
cost
source_format
total_number_of_jobs
project {
...ProjectFragment
}
milestones {
...TranscodingJobMilestoneFragment
}
}
}
Variables
{
"webhook_url": "abc123",
"output_formats": ["xyz789"],
"destination_bucket_path": "abc123",
"destination_bucket_name": "xyz789",
"destination_secret_key": "abc123",
"destination_access_key": "xyz789",
"destination_provider": "abc123",
"source_bucket_path": "abc123",
"source_bucket_name": "abc123",
"source_secret_key": "abc123",
"source_access_key": "abc123",
"source_url": "abc123",
"source_provider": "abc123",
"project_id": "abc123"
}
Response
{
"data": {
"create_transcoding_job": {
"id": "xyz789",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "abc123",
"source_url": "abc123",
"source_provider": "abc123",
"source_access_key": "abc123",
"source_secret_key": "xyz789",
"source_bucket_name": "xyz789",
"source_bucket_path": "xyz789",
"destination_provider": "abc123",
"destination_access_key": "xyz789",
"destination_secret_key": "xyz789",
"destination_bucket_name": "xyz789",
"destination_bucket_path": "abc123",
"output_formats": ["abc123"],
"webhook_url": "abc123",
"status": "abc123",
"error_message": "abc123",
"chargeable_time": 123.45,
"hls_url": "xyz789",
"mp4_url": "xyz789",
"mp3_url": "xyz789",
"thumbnail_url": "xyz789",
"source_file_size": 123.45,
"hls_file_size": 987.65,
"mp4_file_size": 123.45,
"mp3_file_size": 123.45,
"thumbnail_file_size": 123.45,
"cost": 987.65,
"source_format": "abc123",
"total_number_of_jobs": 123.45,
"project": Project,
"milestones": [TranscodingJobMilestone]
}
}
}
create_transcription_job
TranscriptionJob
| Name | Description |
|---|---|
webhook_url -
String
|
An optional webhook to receive updates on this job |
destination_bucket_path -
String
|
The destination provider bucket path |
destination_bucket_name -
String
|
The destination provider bucket name |
destination_secret_key -
String
|
The destination provider secret key |
destination_access_key -
String
|
The destination provider access key |
destination_provider -
String
|
The destination provider to save the transcoded file, must not be URL |
source_bucket_path -
String
|
The source provider bucket path |
source_bucket_name -
String
|
The source provider bucket name |
source_secret_key -
String
|
The source provider secret key |
source_access_key -
String
|
The source provider access key |
source_url -
String
|
The source URL of the file if source provider is URL |
source_provider -
String!
|
The source provider of the file for transcoding job |
project_id -
String!
|
ID of the project that owns the job |
Example
Query
mutation create_transcription_job($webhook_url: String, $destination_bucket_path: String, $destination_bucket_name: String, $destination_secret_key: String, $destination_access_key: String, $destination_provider: String, $source_bucket_path: String, $source_bucket_name: String, $source_secret_key: String, $source_access_key: String, $source_url: String, $source_provider: String!, $project_id: String!) {
create_transcription_job(webhook_url: $webhook_url, destination_bucket_path: $destination_bucket_path, destination_bucket_name: $destination_bucket_name, destination_secret_key: $destination_secret_key, destination_access_key: $destination_access_key, destination_provider: $destination_provider, source_bucket_path: $source_bucket_path, source_bucket_name: $source_bucket_name, source_secret_key: $source_secret_key, source_access_key: $source_access_key, source_url: $source_url, source_provider: $source_provider, project_id: $project_id) {
id
created_at
updated_at
project_id
source_url
destination_url
source_provider
source_access_key
source_secret_key
source_bucket_name
source_bucket_path
destination_provider
destination_access_key
destination_secret_key
destination_bucket_name
destination_bucket_path
webhook_url
status
chargeable_time
cost
total_number_of_jobs
}
}
Variables
{
"webhook_url": "xyz789",
"destination_bucket_path": "xyz789",
"destination_bucket_name": "abc123",
"destination_secret_key": "xyz789",
"destination_access_key": "xyz789",
"destination_provider": "abc123",
"source_bucket_path": "xyz789",
"source_bucket_name": "abc123",
"source_secret_key": "xyz789",
"source_access_key": "xyz789",
"source_url": "xyz789",
"source_provider": "abc123",
"project_id": "abc123"
}
Response
{
"data": {
"create_transcription_job": {
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "abc123",
"source_url": "abc123",
"destination_url": "abc123",
"source_provider": "abc123",
"source_access_key": "abc123",
"source_secret_key": "abc123",
"source_bucket_name": "xyz789",
"source_bucket_path": "abc123",
"destination_provider": "abc123",
"destination_access_key": "abc123",
"destination_secret_key": "abc123",
"destination_bucket_name": "xyz789",
"destination_bucket_path": "abc123",
"webhook_url": "abc123",
"status": "abc123",
"chargeable_time": 987.65,
"cost": 987.65,
"total_number_of_jobs": 123.45
}
}
}
create_user
String!
| Name | Description |
|---|---|
password -
String!
|
The password |
email -
String!
|
The email address of user |
last_name -
String!
|
The last name of user |
first_name -
String!
|
The first name of user |
Example
Query
mutation create_user($password: String!, $email: String!, $last_name: String!, $first_name: String!) {
create_user(password: $password, email: $email, last_name: $last_name, first_name: $first_name)
}
Variables
{
"password": "xyz789",
"email": "xyz789",
"last_name": "xyz789",
"first_name": "abc123"
}
Response
{"data": {"create_user": "abc123"}}
create_video_insight_job
VideoInsight
| Name | Description |
|---|---|
webhook_url -
String
|
An optional webhook to receive updates on this job |
features -
[String!]!
|
Features required by user |
destination_bucket_path -
String
|
The destination provider bucket path |
destination_bucket_name -
String
|
The destination provider bucket name |
destination_secret_key -
String
|
The destination provider secret key |
destination_access_key -
String
|
The destination provider access key |
destination_provider -
String!
|
The destination provider to save the final file, must not be URL |
source_bucket_path -
String
|
The source provider bucket path |
source_bucket_name -
String
|
The source provider bucket name |
source_secret_key -
String
|
The source provider secret key |
source_access_key -
String
|
The source provider access key |
source_url -
String
|
The source URL of the file if source provider is URL |
source_provider -
String!
|
The source provider of the file for video insight job |
project_id -
String!
|
ID of the project that owns the job |
Example
Query
mutation create_video_insight_job($webhook_url: String, $features: [String!]!, $destination_bucket_path: String, $destination_bucket_name: String, $destination_secret_key: String, $destination_access_key: String, $destination_provider: String!, $source_bucket_path: String, $source_bucket_name: String, $source_secret_key: String, $source_access_key: String, $source_url: String, $source_provider: String!, $project_id: String!) {
create_video_insight_job(webhook_url: $webhook_url, features: $features, destination_bucket_path: $destination_bucket_path, destination_bucket_name: $destination_bucket_name, destination_secret_key: $destination_secret_key, destination_access_key: $destination_access_key, destination_provider: $destination_provider, source_bucket_path: $source_bucket_path, source_bucket_name: $source_bucket_name, source_secret_key: $source_secret_key, source_access_key: $source_access_key, source_url: $source_url, source_provider: $source_provider, project_id: $project_id) {
id
created_at
updated_at
project_id
source_url
destination_url
source_provider
source_access_key
source_secret_key
source_bucket_name
source_bucket_path
destination_provider
destination_access_key
destination_secret_key
destination_bucket_name
destination_bucket_path
webhook_url
status
features
chargeable_time
}
}
Variables
{
"webhook_url": "xyz789",
"features": ["xyz789"],
"destination_bucket_path": "abc123",
"destination_bucket_name": "xyz789",
"destination_secret_key": "abc123",
"destination_access_key": "abc123",
"destination_provider": "xyz789",
"source_bucket_path": "xyz789",
"source_bucket_name": "xyz789",
"source_secret_key": "xyz789",
"source_access_key": "abc123",
"source_url": "xyz789",
"source_provider": "abc123",
"project_id": "abc123"
}
Response
{
"data": {
"create_video_insight_job": {
"id": "xyz789",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "abc123",
"source_url": "abc123",
"destination_url": "abc123",
"source_provider": "xyz789",
"source_access_key": "abc123",
"source_secret_key": "xyz789",
"source_bucket_name": "xyz789",
"source_bucket_path": "abc123",
"destination_provider": "abc123",
"destination_access_key": "xyz789",
"destination_secret_key": "abc123",
"destination_bucket_name": "xyz789",
"destination_bucket_path": "xyz789",
"webhook_url": "xyz789",
"status": "abc123",
"features": ["abc123"],
"chargeable_time": 987.65
}
}
}
delete_cdn_distribution
Example
Query
mutation delete_cdn_distribution($id: String!) {
delete_cdn_distribution(id: $id)
}
Variables
{"id": "abc123"}
Response
{"data": {"delete_cdn_distribution": false}}
delete_livestream
Example
Query
mutation delete_livestream($id: String!) {
delete_livestream(id: $id)
}
Variables
{"id": "abc123"}
Response
{"data": {"delete_livestream": true}}
delete_media_library
Example
Query
mutation delete_media_library($id: String!) {
delete_media_library(id: $id)
}
Variables
{"id": "abc123"}
Response
{"data": {"delete_media_library": true}}
delete_media_library_asset
Example
Query
mutation delete_media_library_asset($id: String!) {
delete_media_library_asset(id: $id)
}
Variables
{"id": "xyz789"}
Response
{"data": {"delete_media_library_asset": true}}
delete_project
Example
Query
mutation delete_project($project_id: String!) {
delete_project(project_id: $project_id)
}
Variables
{"project_id": "xyz789"}
Response
{"data": {"delete_project": false}}
delete_project_key
Example
Query
mutation delete_project_key($id: String!) {
delete_project_key(id: $id)
}
Variables
{"id": "xyz789"}
Response
{"data": {"delete_project_key": true}}
delete_project_member
Boolean!
| Name | Description |
|---|---|
project_id -
String!
|
The project ID |
user_id -
String!
|
The user ID |
Example
Query
mutation delete_project_member($project_id: String!, $user_id: String!) {
delete_project_member(project_id: $project_id, user_id: $user_id)
}
Variables
{"project_id": "abc123", "user_id": "xyz789"}
Response
{"data": {"delete_project_member": false}}
delete_static_site
Example
Query
mutation delete_static_site($id: String!) {
delete_static_site(id: $id)
}
Variables
{"id": "abc123"}
Response
{"data": {"delete_static_site": true}}
deploy_site
Boolean!
| Name | Description |
|---|---|
commitUrl -
String
|
The commit url of the git push |
id -
String!
|
The id of the site to rebuild |
Example
Query
mutation deploy_site($commitUrl: String, $id: String!) {
deploy_site(commitUrl: $commitUrl, id: $id)
}
Variables
{"commitUrl": "abc123", "id": "abc123"}
Response
{"data": {"deploy_site": false}}
get_jwt_for_key
Example
Query
mutation get_jwt_for_key($id: String!) {
get_jwt_for_key(id: $id)
}
Variables
{"id": "abc123"}
Response
{"data": {"get_jwt_for_key": "abc123"}}
import_media_library_asset
MediaLibraryAsset!
| Name | Description |
|---|---|
source_bucket_path -
String
|
The source provider bucket path |
source_bucket_name -
String
|
The source provider bucket name |
source_secret_key -
String
|
The source provider secret key |
source_access_key -
String
|
The source provider access key |
source_url -
String
|
The source URL of the asset if source provider is URL |
source_provider -
String!
|
The source provider of the media asset |
tags -
[String!]
|
User provided key-value tags |
name -
String!
|
A user-provided name for the media library asset |
media_library_id -
String!
|
The media library ID |
Example
Query
mutation import_media_library_asset($source_bucket_path: String, $source_bucket_name: String, $source_secret_key: String, $source_access_key: String, $source_url: String, $source_provider: String!, $tags: [String!], $name: String!, $media_library_id: String!) {
import_media_library_asset(source_bucket_path: $source_bucket_path, source_bucket_name: $source_bucket_name, source_secret_key: $source_secret_key, source_access_key: $source_access_key, source_url: $source_url, source_provider: $source_provider, tags: $tags, name: $name, media_library_id: $media_library_id) {
id
created_at
updated_at
media_library_id
name
content_type
original_size
filename
imageinsight_id
transcoding_id
captions_id
source_url
doc_extracted_text
saved_filename
mediaLibrary {
...MediaLibraryFragment
}
tags {
...MediaLibraryAssetTagFragment
}
imageinsight_job {
...ImageInsightJobFragment
}
transcoding_job {
...TranscodingJobFragment
}
captions {
...TranscriptionJobDetailFragment
}
}
}
Variables
{
"source_bucket_path": "abc123",
"source_bucket_name": "abc123",
"source_secret_key": "abc123",
"source_access_key": "abc123",
"source_url": "xyz789",
"source_provider": "xyz789",
"tags": ["abc123"],
"name": "abc123",
"media_library_id": "abc123"
}
Response
{
"data": {
"import_media_library_asset": {
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"media_library_id": "xyz789",
"name": "xyz789",
"content_type": "abc123",
"original_size": 987.65,
"filename": "xyz789",
"imageinsight_id": "xyz789",
"transcoding_id": "abc123",
"captions_id": "abc123",
"source_url": "xyz789",
"doc_extracted_text": "xyz789",
"saved_filename": "xyz789",
"mediaLibrary": MediaLibrary,
"tags": [MediaLibraryAssetTag],
"imageinsight_job": ImageInsightJob,
"transcoding_job": TranscodingJob,
"captions": TranscriptionJobDetail
}
}
}
import_media_library_asset_large
MediaLibraryAsset!
| Name | Description |
|---|---|
source_url -
String
|
The source URL of the asset if source provider is URL |
tags -
[String!]
|
User provided key-value tags |
name -
String!
|
A user-provided name for the media library asset |
media_library_id -
String!
|
The media library ID |
Example
Query
mutation import_media_library_asset_large($source_url: String, $tags: [String!], $name: String!, $media_library_id: String!) {
import_media_library_asset_large(source_url: $source_url, tags: $tags, name: $name, media_library_id: $media_library_id) {
id
created_at
updated_at
media_library_id
name
content_type
original_size
filename
imageinsight_id
transcoding_id
captions_id
source_url
doc_extracted_text
saved_filename
mediaLibrary {
...MediaLibraryFragment
}
tags {
...MediaLibraryAssetTagFragment
}
imageinsight_job {
...ImageInsightJobFragment
}
transcoding_job {
...TranscodingJobFragment
}
captions {
...TranscriptionJobDetailFragment
}
}
}
Variables
{
"source_url": "abc123",
"tags": ["abc123"],
"name": "abc123",
"media_library_id": "xyz789"
}
Response
{
"data": {
"import_media_library_asset_large": {
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"media_library_id": "abc123",
"name": "xyz789",
"content_type": "xyz789",
"original_size": 123.45,
"filename": "xyz789",
"imageinsight_id": "abc123",
"transcoding_id": "abc123",
"captions_id": "abc123",
"source_url": "xyz789",
"doc_extracted_text": "abc123",
"saved_filename": "abc123",
"mediaLibrary": MediaLibrary,
"tags": [MediaLibraryAssetTag],
"imageinsight_job": ImageInsightJob,
"transcoding_job": TranscodingJob,
"captions": TranscriptionJobDetail
}
}
}
load_ssl_certificate
CDNCustomDomain!
| Name | Description |
|---|---|
cdn_id -
String!
|
The cdn Id |
domain -
String!
|
The custom domain for which ssl certificate will be added |
project_id -
String!
|
The project Id |
Example
Query
mutation load_ssl_certificate($cdn_id: String!, $domain: String!, $project_id: String!) {
load_ssl_certificate(cdn_id: $cdn_id, domain: $domain, project_id: $project_id) {
id
created_at
updated_at
cdn_id
domain
ssl
cdn {
...CDNDistributionFragment
}
}
}
Variables
{"cdn_id": "abc123", "domain": "abc123", "project_id": "xyz789"}
Response
{
"data": {
"load_ssl_certificate": {
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"cdn_id": "xyz789",
"domain": "abc123",
"ssl": false,
"cdn": CDNDistribution
}
}
}
payment_under_progress
Example
Query
mutation payment_under_progress($invoice_id: String!) {
payment_under_progress(invoice_id: $invoice_id)
}
Variables
{"invoice_id": "xyz789"}
Response
{"data": {"payment_under_progress": true}}
remove_custom_domain
Boolean!
| Name | Description |
|---|---|
domain -
String!
|
The custom domain that will be removed |
cdn_id -
String!
|
The CDN Id of the static site |
project_id -
String!
|
The project Id |
Example
Query
mutation remove_custom_domain($domain: String!, $cdn_id: String!, $project_id: String!) {
remove_custom_domain(domain: $domain, cdn_id: $cdn_id, project_id: $project_id)
}
Variables
{"domain": "abc123", "cdn_id": "abc123", "project_id": "xyz789"}
Response
{"data": {"remove_custom_domain": true}}
remove_payment_method
Boolean!
| Name | Description |
|---|---|
payment_methods_id -
String!
|
Payment method id from stripe |
project_id -
String!
|
Id of the project using the service |
Example
Query
mutation remove_payment_method($payment_methods_id: String!, $project_id: String!) {
remove_payment_method(payment_methods_id: $payment_methods_id, project_id: $project_id)
}
Variables
{"payment_methods_id": "xyz789", "project_id": "abc123"}
Response
{"data": {"remove_payment_method": false}}
set_custom_domain
CDNCustomDomain!
| Name | Description |
|---|---|
domain -
String!
|
The custom domain that will be added to the static site |
cdn_id -
String!
|
The CDN Id of the static site |
project_id -
String!
|
The project Id |
Example
Query
mutation set_custom_domain($domain: String!, $cdn_id: String!, $project_id: String!) {
set_custom_domain(domain: $domain, cdn_id: $cdn_id, project_id: $project_id) {
id
created_at
updated_at
cdn_id
domain
ssl
cdn {
...CDNDistributionFragment
}
}
}
Variables
{"domain": "xyz789", "cdn_id": "abc123", "project_id": "xyz789"}
Response
{
"data": {
"set_custom_domain": {
"id": "xyz789",
"created_at": DateTime,
"updated_at": DateTime,
"cdn_id": "abc123",
"domain": "abc123",
"ssl": true,
"cdn": CDNDistribution
}
}
}
stripe_payment_intent
String!
| Name | Description |
|---|---|
invoice_id -
String!
|
Invoice id |
payment_method_id -
String!
|
Payment method id from stripe |
Example
Query
mutation stripe_payment_intent($invoice_id: String!, $payment_method_id: String!) {
stripe_payment_intent(invoice_id: $invoice_id, payment_method_id: $payment_method_id)
}
Variables
{"invoice_id": "xyz789", "payment_method_id": "abc123"}
Response
{"data": {"stripe_payment_intent": "abc123"}}
update_backup_job
Example
Query
mutation update_backup_job($status: String!, $id: String!) {
update_backup_job(status: $status, id: $id)
}
Variables
{"status": "abc123", "id": "abc123"}
Response
{"data": {"update_backup_job": true}}
update_card
Boolean!
| Name | Description |
|---|---|
exp_year -
Float!
|
Year of expiry |
exp_month -
Float!
|
Month of expiry |
payment_methods_id -
String!
|
Payment method id from stripe |
project_id -
String!
|
Id of the project using the service |
Example
Query
mutation update_card($exp_year: Float!, $exp_month: Float!, $payment_methods_id: String!, $project_id: String!) {
update_card(exp_year: $exp_year, exp_month: $exp_month, payment_methods_id: $payment_methods_id, project_id: $project_id)
}
Variables
{
"exp_year": 123.45,
"exp_month": 987.65,
"payment_methods_id": "xyz789",
"project_id": "xyz789"
}
Response
{"data": {"update_card": true}}
update_default_card
Boolean!
| Name | Description |
|---|---|
payment_methods_id -
String!
|
Payment method id from stripe |
project_id -
String!
|
Id of the project using the service |
Example
Query
mutation update_default_card($payment_methods_id: String!, $project_id: String!) {
update_default_card(payment_methods_id: $payment_methods_id, project_id: $project_id)
}
Variables
{"payment_methods_id": "abc123", "project_id": "abc123"}
Response
{"data": {"update_default_card": false}}
update_media_library
MediaLibrary!
| Name | Description |
|---|---|
description -
String
|
The updated description for the media library |
name -
String!
|
An updated name for the media library |
id -
String!
|
The media library ID |
Example
Query
mutation update_media_library($description: String, $name: String!, $id: String!) {
update_media_library(description: $description, name: $name, id: $id) {
id
created_at
updated_at
project_id
name
description
video_features
image_features
audio_features
project {
...ProjectFragment
}
assets {
...MediaLibraryAssetFragment
}
assetsCount
assetsSize
}
}
Variables
{"description": "abc123", "name": "abc123", "id": "xyz789"}
Response
{
"data": {
"update_media_library": {
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "abc123",
"name": "xyz789",
"description": "abc123",
"video_features": ["abc123"],
"image_features": ["xyz789"],
"audio_features": ["xyz789"],
"project": Project,
"assets": [MediaLibraryAsset],
"assetsCount": 987.65,
"assetsSize": 987.65
}
}
}
update_media_library_asset
MediaLibraryAsset!
| Name | Description |
|---|---|
tags -
[String!]
|
User provided key-value tags |
name -
String!
|
The updated name for the media library asset |
media_library_asset_id -
String!
|
The media library Asset ID |
Example
Query
mutation update_media_library_asset($tags: [String!], $name: String!, $media_library_asset_id: String!) {
update_media_library_asset(tags: $tags, name: $name, media_library_asset_id: $media_library_asset_id) {
id
created_at
updated_at
media_library_id
name
content_type
original_size
filename
imageinsight_id
transcoding_id
captions_id
source_url
doc_extracted_text
saved_filename
mediaLibrary {
...MediaLibraryFragment
}
tags {
...MediaLibraryAssetTagFragment
}
imageinsight_job {
...ImageInsightJobFragment
}
transcoding_job {
...TranscodingJobFragment
}
captions {
...TranscriptionJobDetailFragment
}
}
}
Variables
{"tags": ["abc123"], "name": "xyz789", "media_library_asset_id": "xyz789"}
Response
{
"data": {
"update_media_library_asset": {
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"media_library_id": "abc123",
"name": "abc123",
"content_type": "xyz789",
"original_size": 987.65,
"filename": "xyz789",
"imageinsight_id": "abc123",
"transcoding_id": "xyz789",
"captions_id": "xyz789",
"source_url": "abc123",
"doc_extracted_text": "abc123",
"saved_filename": "abc123",
"mediaLibrary": MediaLibrary,
"tags": [MediaLibraryAssetTag],
"imageinsight_job": ImageInsightJob,
"transcoding_job": TranscodingJob,
"captions": TranscriptionJobDetail
}
}
}
update_project
Project!
| Name | Description |
|---|---|
company_national_tax_id -
String
|
The national tax ID of the company |
company_address -
String
|
The address of the company |
company_name -
String
|
The name of the company |
project_id -
String!
|
The project id |
description -
String
|
The updated description for the project |
name -
String!
|
The new project name |
Example
Query
mutation update_project($company_national_tax_id: String, $company_address: String, $company_name: String, $project_id: String!, $description: String, $name: String!) {
update_project(company_national_tax_id: $company_national_tax_id, company_address: $company_address, company_name: $company_name, project_id: $project_id, description: $description, name: $name) {
id
name
description
company_name
company_address
company_national_tax_id
created_at
updated_at
keys {
...ProjectKeyFragment
}
cdn_distributions {
...CDNDistributionFragment
}
}
}
Variables
{
"company_national_tax_id": "abc123",
"company_address": "abc123",
"company_name": "abc123",
"project_id": "abc123",
"description": "abc123",
"name": "abc123"
}
Response
{
"data": {
"update_project": {
"id": "abc123",
"name": "abc123",
"description": "xyz789",
"company_name": "abc123",
"company_address": "abc123",
"company_national_tax_id": "abc123",
"created_at": DateTime,
"updated_at": "abc123",
"keys": [ProjectKey],
"cdn_distributions": [CDNDistribution]
}
}
}
update_project_key
ProjectKey!
| Name | Description |
|---|---|
description -
String
|
The updated description for the project key |
name -
String!
|
A new name for the project key |
role -
String!
|
A new role to assign the key, can be either READWRITE or READ |
id -
String!
|
The project key ID |
Example
Query
mutation update_project_key($description: String, $name: String!, $role: String!, $id: String!) {
update_project_key(description: $description, name: $name, role: $role, id: $id) {
id
created_at
updated_at
project_id
role
name
description
last_accessed
secret
project {
...ProjectFragment
}
}
}
Variables
{"description": "xyz789", "name": "xyz789", "role": "abc123", "id": "abc123"}
Response
{
"data": {
"update_project_key": {
"id": "xyz789",
"created_at": DateTime,
"updated_at": "xyz789",
"project_id": "xyz789",
"role": "xyz789",
"name": "abc123",
"description": "abc123",
"last_accessed": "abc123",
"secret": "abc123",
"project": Project
}
}
}
update_project_member
ProjectMember!
| Name | Description |
|---|---|
role -
String!
|
User role you want to update, can be either ADMIN, READWRITE or READ |
id -
String!
|
Example
Query
mutation update_project_member($role: String!, $id: String!) {
update_project_member(role: $role, id: $id) {
id
created_at
updated_at
user_id
project_id
role
project {
...ProjectFragment
}
user {
...UserFragment
}
}
}
Variables
{"role": "xyz789", "id": "abc123"}
Response
{
"data": {
"update_project_member": {
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"user_id": "xyz789",
"project_id": "abc123",
"role": "xyz789",
"project": Project,
"user": User
}
}
}
update_static_site
StaticSite!
| Name | Description |
|---|---|
build_command -
String
|
The build command provided by user |
repo_branch -
String!
|
The branch to deploy |
repo_name -
String!
|
The full name of the repo, e.g. csuitecircle/somerepo |
old_repo_name -
String!
|
The full name of the old repo |
git_account_id -
String!
|
The ID of the git account used to pull source code |
old_git_account_id -
String!
|
The ID of the old git account used to pull source code |
name -
String!
|
The name of the site |
id -
String!
|
Static Site Id |
project_id -
String!
|
The project that will own the site |
Example
Query
mutation update_static_site($build_command: String, $repo_branch: String!, $repo_name: String!, $old_repo_name: String!, $git_account_id: String!, $old_git_account_id: String!, $name: String!, $id: String!, $project_id: String!) {
update_static_site(build_command: $build_command, repo_branch: $repo_branch, repo_name: $repo_name, old_repo_name: $old_repo_name, git_account_id: $git_account_id, old_git_account_id: $old_git_account_id, name: $name, id: $id, project_id: $project_id) {
id
created_at
updated_at
project_id
cdn_id
name
status
git_account_id
repo_name
repo_branch
build_command
project {
...ProjectFragment
}
cdn {
...CDNDistributionFragment
}
builds {
...StaticSiteBuildFragment
}
gitconnect {
...GitConnectFragment
}
}
}
Variables
{
"build_command": "abc123",
"repo_branch": "abc123",
"repo_name": "xyz789",
"old_repo_name": "xyz789",
"git_account_id": "xyz789",
"old_git_account_id": "abc123",
"name": "abc123",
"id": "xyz789",
"project_id": "abc123"
}
Response
{
"data": {
"update_static_site": {
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"project_id": ID,
"cdn_id": "abc123",
"name": "abc123",
"status": "abc123",
"git_account_id": "xyz789",
"repo_name": "abc123",
"repo_branch": "xyz789",
"build_command": "abc123",
"project": Project,
"cdn": CDNDistribution,
"builds": [StaticSiteBuild],
"gitconnect": GitConnect
}
}
}
update_user
User!
| Name | Description |
|---|---|
role -
String!
|
The updated role |
company -
String!
|
The updated company name |
last_name -
String!
|
The updated last name of user |
first_name -
String!
|
The updated first name of user |
Example
Query
mutation update_user($role: String!, $company: String!, $last_name: String!, $first_name: String!) {
update_user(role: $role, company: $company, last_name: $last_name, first_name: $first_name) {
id
created_at
updated_at
first_name
last_name
email
phone
picture
verified
company
role
}
}
Variables
{
"role": "abc123",
"company": "abc123",
"last_name": "xyz789",
"first_name": "xyz789"
}
Response
{
"data": {
"update_user": {
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"first_name": "abc123",
"last_name": "abc123",
"email": "yourname@example.com",
"phone": "xyz789",
"picture": "xyz789",
"verified": false,
"company": "abc123",
"role": "abc123"
}
}
}
Types
AggregateCharge
| Field Name | Description |
|---|---|
period -
DateTime!
|
The period this charge relates to |
total_units -
Int!
|
Total units consumed |
total_cost -
Float
|
Total cost of the usage |
service -
String
|
Type of Service, e.g Transcoding, Image Intelligence, Media Service etc |
Example
{
"period": DateTime,
"total_units": 987,
"total_cost": 123.45,
"service": "abc123"
}
BackupJob
| Field Name | Description |
|---|---|
id -
ID!
|
The ID of the backup job (auto-generated) |
project_id -
String!
|
The ID of the project that owns this backup job |
origin_url -
String!
|
The original location of the file to be backed up. |
etag -
String
|
The etag of the file to be backed up. |
size -
Float
|
The size in bytes of the file to be backed up. |
project -
Project!
|
Example
{
"id": ID,
"project_id": "xyz789",
"origin_url": "abc123",
"etag": "xyz789",
"size": 987.65,
"project": Project
}
CDNCustomDomain
| Field Name | Description |
|---|---|
id -
String!
|
|
created_at -
DateTime!
|
|
updated_at -
DateTime!
|
|
cdn_id -
String!
|
The id for the cdn associated with a custom domain |
domain -
String!
|
The custom domain for the cdn |
ssl -
Boolean!
|
Boolean to check if ssl is turned on or off |
cdn -
CDNDistribution!
|
Example
{
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"cdn_id": "xyz789",
"domain": "xyz789",
"ssl": false,
"cdn": CDNDistribution
}
CDNDistribution
| Field Name | Description |
|---|---|
id -
String!
|
|
created_at -
DateTime!
|
|
updated_at -
DateTime!
|
|
project_id -
String!
|
|
bunny_cdn_id -
String!
|
An integer id which bunny cdn uses to identify their cdn |
endpoint -
String!
|
The url endpoint of the service which would have a cdn |
project -
Project!
|
|
custom_domains -
[CDNCustomDomain!]
|
Example
{
"id": "xyz789",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "xyz789",
"bunny_cdn_id": "xyz789",
"endpoint": "abc123",
"project": Project,
"custom_domains": [CDNCustomDomain]
}
CDNStatistics
| Field Name | Description |
|---|---|
id -
String!
|
|
total_bandwidth_used -
Float
|
|
total_origin_traffic -
Float
|
|
total_requests_served -
Float
|
|
cache_hit_rate -
Float
|
|
bandwidth_used_chart -
[BandwidthUsedChart!]
|
Example
{
"id": "abc123",
"total_bandwidth_used": 987.65,
"total_origin_traffic": 987.65,
"total_requests_served": 123.45,
"cache_hit_rate": 987.65,
"bandwidth_used_chart": [BandwidthUsedChart]
}
CloudAdvisorRecommendation
| Field Name | Description |
|---|---|
id -
String!
|
Service type |
currentServiceUsed -
String!
|
Service used by your website |
title -
String!
|
Recommended service |
description -
String!
|
Brief info on recommended service |
link -
String!
|
Url for recommended service website |
Example
{
"id": "abc123",
"currentServiceUsed": "xyz789",
"title": "abc123",
"description": "abc123",
"link": "xyz789"
}
DateTime
The javascript Date as string. Type represents date and time as the ISO Date string.
Example
"2016-10-10T01:08:03.420Z"
FileConversionJob
| Field Name | Description |
|---|---|
id -
String!
|
|
created_at -
DateTime!
|
The timestamp the fileconversion job created at |
updated_at -
DateTime!
|
The last timestamp the fileconversion job was updated. |
project_id -
String!
|
The ID of the project that owns this job |
source_url -
String
|
The URL of the source file. Cloud bucket sources should be expressed as service://bucket/key, e.g. s3://mybucket/somefile |
destination_url -
String
|
The URL of the upload destination. Cloud bucket sources should be expressed as service://bucket/key, e.g. s3://mybucket/somefile |
output_format -
String!
|
The format to convert to |
webhook_url -
String
|
An optional webhook URL to send |
status -
String!
|
The current status of this fileconversion job |
error_message -
String
|
The error message of this fileconversion job (if any) |
chargeable_time -
Float
|
The number of chargeable seconds taken to perform this fileconversion job. This excludes any time the job spends in the queue. |
cost -
Float
|
The cost of converting a file from one format to another |
original_size -
Float
|
The size of the source file |
converted_size -
Float
|
The size of the converted file |
project -
Project!
|
|
milestones -
[FileConversionJobMilestone!]!
|
Example
{
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "xyz789",
"source_url": "abc123",
"destination_url": "abc123",
"output_format": "xyz789",
"webhook_url": "abc123",
"status": "xyz789",
"error_message": "xyz789",
"chargeable_time": 987.65,
"cost": 987.65,
"original_size": 987.65,
"converted_size": 987.65,
"project": Project,
"milestones": [FileConversionJobMilestone]
}
FileConversionJobMilestone
| Field Name | Description |
|---|---|
id -
String!
|
|
created_at -
DateTime!
|
The timestamp the milestone created at |
file_conversion_job_id -
String!
|
The file conversion job this milestone refers to |
status -
String!
|
The status of the milestone |
Example
{
"id": "xyz789",
"created_at": DateTime,
"file_conversion_job_id": "abc123",
"status": "abc123"
}
FileConversionStat
| Field Name | Description |
|---|---|
totalJobs -
Float
|
|
timeConsumed -
Float
|
|
successfulJobs -
Float
|
|
pendingJobs -
Float
|
|
totalSpending -
Float
|
|
convertedFileSize -
Float
|
Example
{
"totalJobs": 987.65,
"timeConsumed": 123.45,
"successfulJobs": 987.65,
"pendingJobs": 123.45,
"totalSpending": 987.65,
"convertedFileSize": 123.45
}
Float
The Float scalar type represents signed double-precision fractional values as specified by
IEEE 754.
Example
123.45
GitConnect
| Field Name | Description |
|---|---|
id -
String!
|
|
created_at -
DateTime!
|
|
updated_at -
DateTime!
|
|
external_service -
String!
|
Either bitbucket or github |
external_username -
String!
|
The username for the git account. |
external_display_name -
String!
|
The name of the person associated with the git account. |
Example
{
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"external_service": "abc123",
"external_username": "xyz789",
"external_display_name": "xyz789"
}
ID
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"123e4567-e89b-12d3-a456-426614174000"
ImageInsightJob
| Field Name | Description |
|---|---|
id -
String!
|
|
created_at -
DateTime!
|
|
project_id -
String!
|
The ID of the project that owns this job |
source_url -
String
|
The URL of the source file. Cloud bucket sources should be expressed as service://bucket/key, e.g. s3://mybucket/somefile |
destination_url -
String
|
The URL of the upload destination. Cloud bucket sources should be expressed as service://bucket/key, e.g. s3://mybucket/somefile |
status -
String!
|
The current status of the job |
features -
[String!]!
|
The list of features selected for image insights job |
moderation_status -
String
|
The content moderation status for the job |
file_size -
Float
|
The size of the image |
cost -
Float
|
The cost of the image analysed |
project -
Project!
|
|
objects -
[ImageObject!]
|
|
tags -
[ImageTag!]
|
|
metadata -
ImageMetadata
|
|
moderation_nudity -
[ImageModerationNudity!]
|
|
moderation_violence -
[ImageModerationViolence!]
|
Example
{
"id": "xyz789",
"created_at": DateTime,
"project_id": "xyz789",
"source_url": "abc123",
"destination_url": "abc123",
"status": "abc123",
"features": ["abc123"],
"moderation_status": "abc123",
"file_size": 987.65,
"cost": 987.65,
"project": Project,
"objects": [ImageObject],
"tags": [ImageTag],
"metadata": ImageMetadata,
"moderation_nudity": [ImageModerationNudity],
"moderation_violence": [ImageModerationViolence]
}
ImageMetadata
| Field Name | Description |
|---|---|
format -
String!
|
Name of decoder used to decompress image data e.g. jpeg, png, webp, gif, svg |
size -
Float!
|
Total size of image in bytes, for Stream and Buffer input only |
width -
Float!
|
Number of pixels wide (EXIF orientation is not taken into consideration) |
height -
Float!
|
Number of pixels high (EXIF orientation is not taken into consideration) |
channels -
Float!
|
Number of bands e.g. 3 for sRGB, 4 for CMYK |
space -
String!
|
Number of pixels per inch (DPI), if present |
depth -
String!
|
Name of pixel depth format e.g. uchar, char, ushort, float |
chroma_subsampling -
String!
|
String containing JPEG chroma subsampling, 4:2:0 or 4:4:4 for RGB, 4:2:0:4 or 4:4:4:4 for CMYK |
is_progressive -
Boolean!
|
Boolean indicating whether the image is interlaced using a progressive scan |
has_profile -
Boolean!
|
Boolean indicating the presence of an embedded ICC profile |
has_alpha -
Boolean!
|
Boolean indicating the presence of an alpha transparency channel |
Example
{
"format": "xyz789",
"size": 123.45,
"width": 123.45,
"height": 123.45,
"channels": 987.65,
"space": "abc123",
"depth": "abc123",
"chroma_subsampling": "xyz789",
"is_progressive": false,
"has_profile": false,
"has_alpha": false
}
ImageObject
| Field Name | Description |
|---|---|
class -
String!
|
List of classes or objects associated with the image |
score -
Float!
|
The probability score of the detected classes or objects |
bbox -
[Float!]!
|
The location (x, y, width, height) of the detected objects |
Example
{"class": "abc123", "score": 123.45, "bbox": [987.65]}
Int
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
Invoice
| Field Name | Description |
|---|---|
id -
String!
|
|
project_id -
String!
|
ID of the project this invoice relates to |
month -
DateTime!
|
The month this invoice relates to |
total_usd -
Float!
|
Total price |
status -
String!
|
Status of the invoice, e.g, PAID, UNPAID , PENDING, UPCOMING |
due_date -
String
|
Due date of the invoice |
invoice -
[InvoiceItem!]!
|
|
project -
Project!
|
Example
{
"id": "abc123",
"project_id": "abc123",
"month": DateTime,
"total_usd": 123.45,
"status": "xyz789",
"due_date": "abc123",
"invoice": [InvoiceItem],
"project": Project
}
InvoiceItem
| Field Name | Description |
|---|---|
id -
String!
|
|
project_id -
String!
|
ID of the project this invoice relates to |
month -
DateTime!
|
The month this invoice relates to |
billing_sku_id -
String!
|
ID of the service, e.g, LINK_PREVIEW or IMAGE_INTELLIGENCE_REQUEST |
billing_sku_name -
String!
|
Human-readable name of the service |
billing_sku_category -
String!
|
The service category of the charge, e.g. CDN, Storage, Transcoding |
service -
String
|
Service being used |
total_units -
Int!
|
Total units consumed by the project |
price_per_unit -
Float!
|
Price per use (e.g, per gb of bandwidth or per request ) of the service in USD |
Example
{
"id": "abc123",
"project_id": "abc123",
"month": DateTime,
"billing_sku_id": "xyz789",
"billing_sku_name": "xyz789",
"billing_sku_category": "abc123",
"service": "abc123",
"total_units": 123,
"price_per_unit": 987.65
}
InvoiceSettingType
| Field Name | Description |
|---|---|
default_payment_method -
String
|
Default payment method from user setting |
Example
{"default_payment_method": "abc123"}
LivestreamAsset
| Field Name | Description |
|---|---|
id -
String!
|
|
livestream_id -
String!
|
|
is_active -
Boolean!
|
|
duration -
Float
|
|
is_mp4_available -
Boolean!
|
|
created_at -
DateTime!
|
|
livestream -
Livestream!
|
Example
{
"id": "abc123",
"livestream_id": "abc123",
"is_active": false,
"duration": 987.65,
"is_mp4_available": false,
"created_at": DateTime,
"livestream": Livestream
}
MediaLibrary
| Field Name | Description |
|---|---|
id -
ID!
|
|
created_at -
DateTime!
|
|
updated_at -
DateTime!
|
|
project_id -
String!
|
The ID of the project that owns this media library. |
name -
String!
|
A user provided name for this library. Not unique. |
description -
String
|
The description of the library |
video_features -
[String!]
|
The list of video features to apply on all uploaded videos of the media library |
image_features -
[String!]
|
The list of image features to apply on all uploaded images of the media library |
audio_features -
[String!]
|
The list of audio features to apply on all uploaded audio files of the media library |
project -
Project!
|
|
assets -
[MediaLibraryAsset!]!
|
|
assetsCount -
Float
|
|
assetsSize -
Float
|
Example
{
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "xyz789",
"name": "abc123",
"description": "abc123",
"video_features": ["xyz789"],
"image_features": ["xyz789"],
"audio_features": ["abc123"],
"project": Project,
"assets": [MediaLibraryAsset],
"assetsCount": 987.65,
"assetsSize": 123.45
}
MediaLibraryAsset
| Field Name | Description |
|---|---|
id -
ID!
|
|
created_at -
DateTime
|
|
updated_at -
DateTime
|
|
media_library_id -
String!
|
The ID of the media library that owns asset |
name -
String
|
A user provided name for this asset. Not unique. |
content_type -
String!
|
The content type of the media asset in MIME format (e.g. image/jpeg) |
original_size -
Float!
|
The size of the media asset in bytes |
filename -
String
|
The stored filename of asset |
imageinsight_id -
String
|
The imageinsight job id for the media library asset (if any imageinsight feature selected) |
transcoding_id -
String
|
The transcoding job id for the media library asset (if transcoding feature selected) |
captions_id -
String
|
The captions job id for the media library asset (if captions feature selected) |
source_url -
String
|
The input file url uploaded on our s3 bucket |
doc_extracted_text -
String
|
The extracted text from doc type assets |
saved_filename -
String
|
The saved file name |
mediaLibrary -
MediaLibrary!
|
|
tags -
[MediaLibraryAssetTag!]!
|
|
imageinsight_job -
ImageInsightJob
|
|
transcoding_job -
TranscodingJob
|
|
captions -
TranscriptionJobDetail
|
Example
{
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"media_library_id": "xyz789",
"name": "xyz789",
"content_type": "abc123",
"original_size": 123.45,
"filename": "xyz789",
"imageinsight_id": "xyz789",
"transcoding_id": "abc123",
"captions_id": "abc123",
"source_url": "xyz789",
"doc_extracted_text": "xyz789",
"saved_filename": "xyz789",
"mediaLibrary": MediaLibrary,
"tags": [MediaLibraryAssetTag],
"imageinsight_job": ImageInsightJob,
"transcoding_job": TranscodingJob,
"captions": TranscriptionJobDetail
}
MediaLibraryAssetTag
| Field Name | Description |
|---|---|
id -
ID!
|
|
created_at -
DateTime
|
|
updated_at -
DateTime
|
|
media_library_asset_id -
String!
|
The ID of the media library asset that owns tags |
key -
String
|
A user provided key for the tag |
value -
String!
|
A user provided value for the tag |
Example
{
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"media_library_asset_id": "xyz789",
"key": "xyz789",
"value": "xyz789"
}
Project
| Field Name | Description |
|---|---|
id -
String
|
|
name -
String
|
The name of the project |
description -
String
|
The description of the project |
company_name -
String
|
The name of the company |
company_address -
String
|
The address of the company |
company_national_tax_id -
String
|
The national tax ID of the company |
created_at -
DateTime
|
|
updated_at -
String
|
|
keys -
[ProjectKey!]!
|
|
cdn_distributions -
[CDNDistribution!]
|
Example
{
"id": "abc123",
"name": "abc123",
"description": "xyz789",
"company_name": "xyz789",
"company_address": "xyz789",
"company_national_tax_id": "abc123",
"created_at": DateTime,
"updated_at": "xyz789",
"keys": [ProjectKey],
"cdn_distributions": [CDNDistribution]
}
ProjectKey
| Field Name | Description |
|---|---|
id -
String!
|
|
created_at -
DateTime!
|
|
updated_at -
String!
|
|
project_id -
String!
|
The ID of the project that owns the key. |
role -
String!
|
Role assigned to the key, can be either READWRITE or READ |
name -
String!
|
The name of the project key |
description -
String
|
The description of the project key |
last_accessed -
String
|
The timestamp when this key last accessed |
secret -
String
|
The key secret |
project -
Project!
|
Example
{
"id": "xyz789",
"created_at": DateTime,
"updated_at": "xyz789",
"project_id": "xyz789",
"role": "xyz789",
"name": "xyz789",
"description": "xyz789",
"last_accessed": "abc123",
"secret": "xyz789",
"project": Project
}
ProjectMember
| Field Name | Description |
|---|---|
id -
String!
|
|
created_at -
DateTime!
|
|
updated_at -
DateTime!
|
|
user_id -
String!
|
|
project_id -
String!
|
|
role -
String!
|
The role assigned to user, can be either ADMIN, DEVELOPER OR VIEWER |
project -
Project!
|
|
user -
User!
|
Example
{
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"user_id": "xyz789",
"project_id": "abc123",
"role": "abc123",
"project": Project,
"user": User
}
StaticSite
| Field Name | Description |
|---|---|
id -
ID!
|
The ID of the static site |
created_at -
DateTime!
|
|
updated_at -
DateTime!
|
|
project_id -
ID!
|
|
cdn_id -
String!
|
The ID of the auto-generated CDN |
name -
String!
|
A user-provided name for the static site |
status -
String!
|
Status of a static site, either "ACTIVE" or "KILLED" |
git_account_id -
String!
|
The ID of the connected git account used to pull source code |
repo_name -
String!
|
The full name of the repo relative to the service, e.g. csuitecircle/somerepo |
repo_branch -
String!
|
The branch to deploy |
build_command -
String
|
The build command provided by user |
project -
Project!
|
|
cdn -
CDNDistribution!
|
|
builds -
[StaticSiteBuild!]!
|
|
gitconnect -
GitConnect!
|
Example
{
"id": ID,
"created_at": DateTime,
"updated_at": DateTime,
"project_id": ID,
"cdn_id": "abc123",
"name": "xyz789",
"status": "xyz789",
"git_account_id": "xyz789",
"repo_name": "abc123",
"repo_branch": "xyz789",
"build_command": "abc123",
"project": Project,
"cdn": CDNDistribution,
"builds": [StaticSiteBuild],
"gitconnect": GitConnect
}
StaticSiteBuild
| Field Name | Description |
|---|---|
id -
ID!
|
The ID of the static site |
created_at -
DateTime!
|
|
static_site_id -
ID!
|
The static site ID |
start_time -
DateTime!
|
The start time of the build |
duration -
Float!
|
The total duration of the build |
end_time -
DateTime!
|
The end time of the build |
status -
String!
|
The status of a static site build, either "COMPLETED" or "FAILED" |
logs -
String!
|
The logs of the build |
commit_url -
String
|
The commit url of the git push |
static_site -
StaticSite!
|
Example
{
"id": ID,
"created_at": DateTime,
"static_site_id": ID,
"start_time": DateTime,
"duration": 987.65,
"end_time": DateTime,
"status": "xyz789",
"logs": "xyz789",
"commit_url": "abc123",
"static_site": StaticSite
}
String
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
StripeCustomerType
| Field Name | Description |
|---|---|
id -
String!
|
ID of cardT |
invoice_settings -
InvoiceSettingType
|
Invoice setting contain default card |
payment_methods -
[PaymentMethodType!]
|
Array of all payment methods from user |
Example
{
"id": "xyz789",
"invoice_settings": InvoiceSettingType,
"payment_methods": [PaymentMethodType]
}
TranscodingJob
| Field Name | Description |
|---|---|
id -
String!
|
|
created_at -
DateTime!
|
The timestamp the transcoding job created at |
updated_at -
DateTime!
|
The last timestamp the transcoding job was updated. |
project_id -
String!
|
The ID of the project that owns this job |
source_url -
String
|
The URL of the source file. Cloud bucket sources should be expressed as service://bucket/key, e.g. s3://mybucket/somefile |
source_provider -
String
|
The source provider of the file for transcoding job |
source_access_key -
String
|
The source provider access key |
source_secret_key -
String
|
The source provider secret key |
source_bucket_name -
String
|
The source provider bucket name |
source_bucket_path -
String
|
The source provider bucket path |
destination_provider -
String
|
The destination provider of the file for transcoding job |
destination_access_key -
String
|
The destination provider access key |
destination_secret_key -
String
|
The destination provider secret key |
destination_bucket_name -
String
|
The destination provider bucket name |
destination_bucket_path -
String
|
The destination provider bucket path |
output_formats -
[String!]!
|
The formats to transcode to, for example ["HLS", "MP3"] |
webhook_url -
String
|
An optional webhook URL to send |
status -
String!
|
The current status of this transcoding job |
error_message -
String
|
The error message of this transcoding job (if any) |
chargeable_time -
Float
|
The number of chargeable seconds taken to perform this transcoding job. This excludes any time the job spends in the queue. |
hls_url -
String
|
The URL of the converted & uploaded HLS file |
mp4_url -
String
|
The URL of the converted & uploaded MP4 file |
mp3_url -
String
|
The URL of the converted & uploaded MP3 file |
thumbnail_url -
String
|
The URL of the converted & uploaded thumbnail |
source_file_size -
Float
|
The source/input file size |
hls_file_size -
Float
|
The generated HLS files size (includes all the ts & m3u8 files) |
mp4_file_size -
Float
|
The generated MP4 file size |
mp3_file_size -
Float
|
The generated MP3 file size |
thumbnail_file_size -
Float
|
The generated Thumbnails size (includes all the thumbnails) |
cost -
Float
|
The cost of the transcoding job |
source_format -
String
|
The input/source file format |
total_number_of_jobs -
Float
|
Total number of transcoding jobs |
project -
Project!
|
|
milestones -
[TranscodingJobMilestone!]!
|
Example
{
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "abc123",
"source_url": "abc123",
"source_provider": "abc123",
"source_access_key": "abc123",
"source_secret_key": "xyz789",
"source_bucket_name": "xyz789",
"source_bucket_path": "abc123",
"destination_provider": "xyz789",
"destination_access_key": "xyz789",
"destination_secret_key": "xyz789",
"destination_bucket_name": "abc123",
"destination_bucket_path": "xyz789",
"output_formats": ["abc123"],
"webhook_url": "xyz789",
"status": "xyz789",
"error_message": "xyz789",
"chargeable_time": 987.65,
"hls_url": "abc123",
"mp4_url": "xyz789",
"mp3_url": "abc123",
"thumbnail_url": "xyz789",
"source_file_size": 123.45,
"hls_file_size": 123.45,
"mp4_file_size": 123.45,
"mp3_file_size": 123.45,
"thumbnail_file_size": 987.65,
"cost": 987.65,
"source_format": "xyz789",
"total_number_of_jobs": 987.65,
"project": Project,
"milestones": [TranscodingJobMilestone]
}
TranscodingJobMilestone
| Field Name | Description |
|---|---|
id -
String!
|
|
created_at -
DateTime!
|
The timestamp the milestone created at |
transcoding_job_id -
String!
|
The transcoding job this milestone refers to |
status -
String!
|
The status of the milestone |
Example
{
"id": "xyz789",
"created_at": DateTime,
"transcoding_job_id": "abc123",
"status": "xyz789"
}
TranscriptionJob
| Field Name | Description |
|---|---|
id -
String!
|
|
created_at -
DateTime!
|
The timestamp the transcription job created at |
updated_at -
DateTime!
|
The last timestamp the transcription job was updated. |
project_id -
String!
|
The ID of the project that owns this job |
source_url -
String
|
The URL of the source file. Cloud bucket sources should be expressed as service://bucket/key, e.g. s3://mybucket/somefile |
destination_url -
String
|
The URL of the upload destination. Cloud bucket sources should be expressed as service://bucket/key, e.g. s3://mybucket/somefile |
source_provider -
String
|
The source provider of the file for transcription job |
source_access_key -
String
|
The source provider access key |
source_secret_key -
String
|
The source provider secret key |
source_bucket_name -
String
|
The source provider bucket name |
source_bucket_path -
String
|
The source provider bucket path |
destination_provider -
String
|
The destination provider of the file for transcription job |
destination_access_key -
String
|
The destination provider access key |
destination_secret_key -
String
|
The destination provider secret key |
destination_bucket_name -
String
|
The destination provider bucket name |
destination_bucket_path -
String
|
The destination provider bucket path |
webhook_url -
String
|
An optional webhook URL to send |
status -
String!
|
The current status of this transcription job |
chargeable_time -
Float
|
The number of chargeable seconds taken to perform this transcription job. This excludes any time the job spends in the queue. |
cost -
Float
|
The cost of the transcription job |
total_number_of_jobs -
Float
|
Total number of transccription jobs |
Example
{
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "xyz789",
"source_url": "abc123",
"destination_url": "xyz789",
"source_provider": "xyz789",
"source_access_key": "xyz789",
"source_secret_key": "abc123",
"source_bucket_name": "xyz789",
"source_bucket_path": "xyz789",
"destination_provider": "xyz789",
"destination_access_key": "xyz789",
"destination_secret_key": "xyz789",
"destination_bucket_name": "abc123",
"destination_bucket_path": "abc123",
"webhook_url": "xyz789",
"status": "xyz789",
"chargeable_time": 123.45,
"cost": 123.45,
"total_number_of_jobs": 987.65
}
TranscriptionJobDetail
| Field Name | Description |
|---|---|
id -
String!
|
|
created_at -
DateTime!
|
The timestamp the transcription job created at |
updated_at -
DateTime!
|
The last timestamp the transcription job was updated. |
project_id -
String!
|
The ID of the project that owns this job |
source_url -
String
|
The URL of the source file. Cloud bucket sources should be expressed as service://bucket/key, e.g. s3://mybucket/somefile |
destination_url -
String
|
The URL of the upload destination. Cloud bucket sources should be expressed as service://bucket/key, e.g. s3://mybucket/somefile |
source_provider -
String
|
The source provider of the file for transcription job |
source_access_key -
String
|
The source provider access key |
source_secret_key -
String
|
The source provider secret key |
source_bucket_name -
String
|
The source provider bucket name |
source_bucket_path -
String
|
The source provider bucket path |
destination_provider -
String
|
The destination provider of the file for transcription job |
destination_access_key -
String
|
The destination provider access key |
destination_secret_key -
String
|
The destination provider secret key |
destination_bucket_name -
String
|
The destination provider bucket name |
destination_bucket_path -
String
|
The destination provider bucket path |
webhook_url -
String
|
An optional webhook URL to send |
status -
String!
|
The current status of this transcription job |
chargeable_time -
Float
|
The number of chargeable seconds taken to perform this transcription job. This excludes any time the job spends in the queue. |
cost -
Float
|
The cost of the transcription job |
total_number_of_jobs -
Float
|
Total number of transccription jobs |
captions -
[CaptionObj!]
|
|
captionsVtt -
String!
|
Example
{
"id": "xyz789",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "xyz789",
"source_url": "abc123",
"destination_url": "xyz789",
"source_provider": "xyz789",
"source_access_key": "abc123",
"source_secret_key": "abc123",
"source_bucket_name": "xyz789",
"source_bucket_path": "xyz789",
"destination_provider": "xyz789",
"destination_access_key": "xyz789",
"destination_secret_key": "xyz789",
"destination_bucket_name": "xyz789",
"destination_bucket_path": "xyz789",
"webhook_url": "abc123",
"status": "abc123",
"chargeable_time": 123.45,
"cost": 123.45,
"total_number_of_jobs": 987.65,
"captions": [CaptionObj],
"captionsVtt": "xyz789"
}
User
| Field Name | Description |
|---|---|
id -
String!
|
|
created_at -
DateTime!
|
The timestamp the User joined ECS. |
updated_at -
DateTime!
|
The last timestamp the User details were updated. |
first_name -
String
|
The first name of the User |
last_name -
String
|
The last name of the User |
email -
String!
|
The primary email address of the User |
phone -
String
|
The primary phone number of the User in E.164 format |
picture -
String
|
The profile picture of the User |
verified -
Boolean
|
Whether the user account has been verified |
company -
String
|
User company/organization name |
role -
String
|
The role/occupation of the User |
Example
{
"id": "abc123",
"created_at": DateTime,
"updated_at": DateTime,
"first_name": "xyz789",
"last_name": "abc123",
"email": "yourname@example.com",
"phone": "abc123",
"picture": "abc123",
"verified": false,
"company": "abc123",
"role": "xyz789"
}
VideoInsight
| Field Name | Description |
|---|---|
id -
String!
|
|
created_at -
DateTime!
|
The timestamp the video insight job created at |
updated_at -
DateTime!
|
The last timestamp the video insight job was updated. |
project_id -
String!
|
The ID of the project that owns this job |
source_url -
String
|
The URL of the source file. Cloud bucket sources should be expressed as service://bucket/key, e.g. s3://mybucket/somefile |
destination_url -
String
|
The URL of the upload destination. Cloud bucket sources should be expressed as service://bucket/key, e.g. s3://mybucket/somefile |
source_provider -
String
|
The source provider of the file for video insight job |
source_access_key -
String
|
The source provider access key |
source_secret_key -
String
|
The source provider secret key |
source_bucket_name -
String
|
The source provider bucket name |
source_bucket_path -
String
|
The source provider bucket path |
destination_provider -
String
|
The destination provider of the file for video insight job |
destination_access_key -
String
|
The destination provider access key |
destination_secret_key -
String
|
The destination provider secret key |
destination_bucket_name -
String
|
The destination provider bucket name |
destination_bucket_path -
String
|
The destination provider bucket path |
webhook_url -
String
|
An optional webhook URL to send |
status -
String!
|
The current status of this video insight job |
features -
[String!]
|
list of features required for job |
chargeable_time -
Float
|
The number of chargeable seconds taken to perform this video insight job. This excludes any time the job spends in the queue. |
Example
{
"id": "xyz789",
"created_at": DateTime,
"updated_at": DateTime,
"project_id": "abc123",
"source_url": "abc123",
"destination_url": "xyz789",
"source_provider": "abc123",
"source_access_key": "abc123",
"source_secret_key": "xyz789",
"source_bucket_name": "xyz789",
"source_bucket_path": "abc123",
"destination_provider": "abc123",
"destination_access_key": "xyz789",
"destination_secret_key": "abc123",
"destination_bucket_name": "xyz789",
"destination_bucket_path": "xyz789",
"webhook_url": "xyz789",
"status": "xyz789",
"features": ["abc123"],
"chargeable_time": 987.65
}