Collections

Create Project And Run

Request Sample

const result = await mediaviz.projects.createProjectAndRun(
  '<NAME>',
  '<PRIVATE_>',
  '<TYPE>',
  '<DESCRIPTION>',
  '<DIRECTORY>',
  '<PHOTO_UPLOAD_VECTOR>',
  '<THUMBNAIL>',
  '<RUN_NAME>',
  {
    outcomes: '<OUTCOMES>',
    models: '<MODELS>'
  }
);

import type { ProjectRunDisplay } from '@mediaviz/sdk';

const result: ProjectRunDisplay = await mediaviz.projects.createProjectAndRun(
  '<NAME>',
  '<PRIVATE_>',
  '<TYPE>',
  '<DESCRIPTION>',
  '<DIRECTORY>',
  '<PHOTO_UPLOAD_VECTOR>',
  '<THUMBNAIL>',
  '<RUN_NAME>',
  {
    outcomes: '<OUTCOMES>',
    models: '<MODELS>'
  }
);

const result = await mediaviz.projects.createProjectAndRun(
  '<NAME>',
  '<PRIVATE_>',
  '<TYPE>',
  '<DESCRIPTION>',
  '<DIRECTORY>',
  '<PHOTO_UPLOAD_VECTOR>',
  '<THUMBNAIL>',
  '<RUN_NAME>',
  {
    outcomes: '<OUTCOMES>',
    models: '<MODELS>'
  }
);

result = mediaviz.projects.create_project_and_run(
    '<NAME>',
    '<PRIVATE_>',
    '<TYPE>',
    '<DESCRIPTION>',
    '<DIRECTORY>',
    '<PHOTO_UPLOAD_VECTOR>',
    '<THUMBNAIL>',
    '<RUN_NAME>',
    outcomes='<OUTCOMES>',
    models='<MODELS>'
)

$result = $mediaviz->projects->createProjectAndRun(
  '<NAME>',
  '<PRIVATE_>',
  '<TYPE>',
  '<DESCRIPTION>',
  '<DIRECTORY>',
  '<PHOTO_UPLOAD_VECTOR>',
  '<THUMBNAIL>',
  '<RUN_NAME>',
  [
    'outcomes' => '<OUTCOMES>',
    'models' => '<MODELS>'
  ]
);

curl -X POST 'https://api.mediaviz.ai/api/v1/project_outcome/' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo' \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "name": "<NAME>",
  "private": "<PRIVATE>",
  "type": "<TYPE>",
  "description": "<DESCRIPTION>",
  "directory": "<DIRECTORY>",
  "photo_upload_vector": "<PHOTO_UPLOAD_VECTOR>",
  "thumbnail": "<THUMBNAIL>",
  "run_name": "<RUN_NAME>"
}
JSON

Mark Project Upload Complete

Request Sample

const result = await mediaviz.projects.markProjectUploadComplete(
  '<PROJECT_TABLE_NAME>',
  {
    skippedFileCount: '<SKIPPED_FILE_COUNT>'
  }
);

const result = await mediaviz.projects.markProjectUploadComplete(
  '<PROJECT_TABLE_NAME>',
  {
    skippedFileCount: '<SKIPPED_FILE_COUNT>'
  }
);

const result = await mediaviz.projects.markProjectUploadComplete(
  '<PROJECT_TABLE_NAME>',
  {
    skippedFileCount: '<SKIPPED_FILE_COUNT>'
  }
);

result = mediaviz.projects.mark_project_upload_complete(
    '<PROJECT_TABLE_NAME>',
    skipped_file_count='<SKIPPED_FILE_COUNT>'
)

$result = $mediaviz->projects->markProjectUploadComplete(
  '<PROJECT_TABLE_NAME>',
  [
    'skippedFileCount' => '<SKIPPED_FILE_COUNT>'
  ]
);

curl -X POST 'https://api.mediaviz.ai/api/v1/project/<PROJECT_TABLE_NAME>/upload_complete/' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Check Project Status

Request Sample

const result = await mediaviz.projects.checkProjectStatus('<PROJECT_TABLE_NAME>');

const result = await mediaviz.projects.checkProjectStatus('<PROJECT_TABLE_NAME>');

const result = await mediaviz.projects.checkProjectStatus('<PROJECT_TABLE_NAME>');

result = mediaviz.projects.check_project_status('<PROJECT_TABLE_NAME>')

$result = $mediaviz->projects->checkProjectStatus('<PROJECT_TABLE_NAME>');

curl -X GET 'https://api.mediaviz.ai/api/v1/project/status/<PROJECT_TABLE_NAME>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Get Project Prelim Model Request Template

Request Sample

const result = await mediaviz.projects.getProjectPrelimModelRequestTemplate('<PROJECT_TABLE_NAME>');

const result = await mediaviz.projects.getProjectPrelimModelRequestTemplate('<PROJECT_TABLE_NAME>');

const result = await mediaviz.projects.getProjectPrelimModelRequestTemplate('<PROJECT_TABLE_NAME>');

result = mediaviz.projects.get_project_prelim_model_request_template('<PROJECT_TABLE_NAME>')

$result = $mediaviz->projects->getProjectPrelimModelRequestTemplate('<PROJECT_TABLE_NAME>');

curl -X GET 'https://api.mediaviz.ai/api/v1/project_outcome/<PROJECT_TABLE_NAME>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Get User Projects

Request Sample

const result = await mediaviz.projects.getUserProjects();

import type { ProjectRunDisplay } from '@mediaviz/sdk';

const result: ProjectRunDisplay[] = await mediaviz.projects.getUserProjects();

const result = await mediaviz.projects.getUserProjects();

result = mediaviz.projects.get_user_projects()

$result = $mediaviz->projects->getUserProjects();

curl -X GET 'https://api.mediaviz.ai/api/v1/projects/user' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Get Admin Projects

Request Sample

const result = await mediaviz.projects.getAdminProjects();

import type { ProjectRunDisplay } from '@mediaviz/sdk';

const result: ProjectRunDisplay[] = await mediaviz.projects.getAdminProjects();

const result = await mediaviz.projects.getAdminProjects();

result = mediaviz.projects.get_admin_projects()

$result = $mediaviz->projects->getAdminProjects();

curl -X GET 'https://api.mediaviz.ai/api/v1/projects/admin' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Get Project By Id

Request Sample

const result = await mediaviz.projects.getProjectById('<PROJECT_ID>');

import type { ProjectRunDisplay } from '@mediaviz/sdk';

const result: ProjectRunDisplay = await mediaviz.projects.getProjectById('<PROJECT_ID>');

const result = await mediaviz.projects.getProjectById('<PROJECT_ID>');

result = mediaviz.projects.get_project_by_id('<PROJECT_ID>')

$result = $mediaviz->projects->getProjectById('<PROJECT_ID>');

curl -X GET 'https://api.mediaviz.ai/api/v1/projects/<PROJECT_ID>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Get Project By Directory

Request Sample

const result = await mediaviz.projects.getProjectByDirectory('<DIRECTORY>');

import type { ProjectRunDisplay } from '@mediaviz/sdk';

const result: ProjectRunDisplay = await mediaviz.projects.getProjectByDirectory('<DIRECTORY>');

const result = await mediaviz.projects.getProjectByDirectory('<DIRECTORY>');

result = mediaviz.projects.get_project_by_directory('<DIRECTORY>')

$result = $mediaviz->projects->getProjectByDirectory('<DIRECTORY>');

curl -X GET 'https://api.mediaviz.ai/api/v1/projects/directory/{directory:path}' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Update Project

Request Sample

const result = await mediaviz.projects.updateProject(
  '<PROJECT_ID>',
  {
    private: '<PRIVATE>',
    type: '<TYPE>',
    description: '<DESCRIPTION>',
    directory: '<DIRECTORY>',
    name: '<NAME>',
    thumbnail: '<THUMBNAIL>'
  }
);

import type { ProjectRunDisplay } from '@mediaviz/sdk';

const result: ProjectRunDisplay = await mediaviz.projects.updateProject(
  '<PROJECT_ID>',
  {
    private: '<PRIVATE>',
    type: '<TYPE>',
    description: '<DESCRIPTION>',
    directory: '<DIRECTORY>',
    name: '<NAME>',
    thumbnail: '<THUMBNAIL>'
  }
);

const result = await mediaviz.projects.updateProject(
  '<PROJECT_ID>',
  {
    private: '<PRIVATE>',
    type: '<TYPE>',
    description: '<DESCRIPTION>',
    directory: '<DIRECTORY>',
    name: '<NAME>',
    thumbnail: '<THUMBNAIL>'
  }
);

result = mediaviz.projects.update_project(
    '<PROJECT_ID>',
    private='<PRIVATE>',
    type='<TYPE>',
    description='<DESCRIPTION>',
    directory='<DIRECTORY>',
    name='<NAME>',
    thumbnail='<THUMBNAIL>'
)

$result = $mediaviz->projects->updateProject(
  '<PROJECT_ID>',
  [
    'private' => '<PRIVATE>',
    'type' => '<TYPE>',
    'description' => '<DESCRIPTION>',
    'directory' => '<DIRECTORY>',
    'name' => '<NAME>',
    'thumbnail' => '<THUMBNAIL>'
  ]
);

curl -X PUT 'https://api.mediaviz.ai/api/v1/projects/<PROJECT_ID>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo' \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "private": "<PRIVATE>",
  "type": "<TYPE>",
  "description": "<DESCRIPTION>",
  "directory": "<DIRECTORY>",
  "name": "<NAME>",
  "thumbnail": "<THUMBNAIL>"
}
JSON

Update Project Photo Count

Request Sample

const result = await mediaviz.projects.updateProjectPhotoCount(
  '<TABLE_NAME>',
  {
    filesFailedCount: '<FILES_FAILED_COUNT>'
  }
);

const result = await mediaviz.projects.updateProjectPhotoCount(
  '<TABLE_NAME>',
  {
    filesFailedCount: '<FILES_FAILED_COUNT>'
  }
);

const result = await mediaviz.projects.updateProjectPhotoCount(
  '<TABLE_NAME>',
  {
    filesFailedCount: '<FILES_FAILED_COUNT>'
  }
);

result = mediaviz.projects.update_project_photo_count('<TABLE_NAME>', files_failed_count='<FILES_FAILED_COUNT>')

$result = $mediaviz->projects->updateProjectPhotoCount(
  '<TABLE_NAME>',
  [
    'filesFailedCount' => '<FILES_FAILED_COUNT>'
  ]
);

curl -X PUT 'https://api.mediaviz.ai/api/v1/projects_photos/<TABLE_NAME>/' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Update Project Create Upload Report

Request Sample

const result = await mediaviz.projects.updateProjectCreateUploadReport(
  '<TABLE_NAME>',
  {
    filesFailedCount: '<FILES_FAILED_COUNT>'
  }
);

const result = await mediaviz.projects.updateProjectCreateUploadReport(
  '<TABLE_NAME>',
  {
    filesFailedCount: '<FILES_FAILED_COUNT>'
  }
);

const result = await mediaviz.projects.updateProjectCreateUploadReport(
  '<TABLE_NAME>',
  {
    filesFailedCount: '<FILES_FAILED_COUNT>'
  }
);

result = mediaviz.projects.update_project_create_upload_report('<TABLE_NAME>', files_failed_count='<FILES_FAILED_COUNT>')

$result = $mediaviz->projects->updateProjectCreateUploadReport(
  '<TABLE_NAME>',
  [
    'filesFailedCount' => '<FILES_FAILED_COUNT>'
  ]
);

curl -X PUT 'https://api.mediaviz.ai/api/v1/project_upload_report/<TABLE_NAME>/' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Request Project Export

Request Sample

const result = await mediaviz.projects.requestProjectExport('<PROJECT_TABLE_NAME>');

const result = await mediaviz.projects.requestProjectExport('<PROJECT_TABLE_NAME>');

const result = await mediaviz.projects.requestProjectExport('<PROJECT_TABLE_NAME>');

result = mediaviz.projects.request_project_export('<PROJECT_TABLE_NAME>')

$result = $mediaviz->projects->requestProjectExport('<PROJECT_TABLE_NAME>');

curl -X GET 'https://api.mediaviz.ai/api/v1/projects_export/<PROJECT_TABLE_NAME>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Get Project Data Export Upload Status

Request Sample

const result = await mediaviz.projects.getProjectDataExportUploadStatus('<PROJECT_TABLE_NAME>', '<MODEL_NAME>');

import type { AnalysisStatusResponse } from '@mediaviz/sdk';

const result: AnalysisStatusResponse = await mediaviz.projects.getProjectDataExportUploadStatus('<PROJECT_TABLE_NAME>', '<MODEL_NAME>');

const result = await mediaviz.projects.getProjectDataExportUploadStatus('<PROJECT_TABLE_NAME>', '<MODEL_NAME>');

result = mediaviz.projects.get_project_data_export_upload_status('<PROJECT_TABLE_NAME>', '<MODEL_NAME>')

$result = $mediaviz->projects->getProjectDataExportUploadStatus('<PROJECT_TABLE_NAME>', '<MODEL_NAME>');

curl -X GET 'https://api.mediaviz.ai/api/v1/projects/<PROJECT_TABLE_NAME>/upload_status/<MODEL_NAME>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'

Add Project Event

Request Sample

const result = await mediaviz.projects.addProjectEvent('<PROJECT_TABLE_NAME>', '<EVENT>', '<DETAIL>');

const result = await mediaviz.projects.addProjectEvent('<PROJECT_TABLE_NAME>', '<EVENT>', '<DETAIL>');

const result = await mediaviz.projects.addProjectEvent('<PROJECT_TABLE_NAME>', '<EVENT>', '<DETAIL>');

result = mediaviz.projects.add_project_event('<PROJECT_TABLE_NAME>', '<EVENT>', '<DETAIL>')

$result = $mediaviz->projects->addProjectEvent('<PROJECT_TABLE_NAME>', '<EVENT>', '<DETAIL>');

curl -X POST 'https://api.mediaviz.ai/api/v1/projects/<PROJECT_TABLE_NAME>/event' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo' \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "event": "<EVENT>",
  "detail": "<DETAIL>"
}
JSON

Delete Project

Request Sample

const result = await mediaviz.projects.deleteProject('<PROJECT_ID>');

const result = await mediaviz.projects.deleteProject('<PROJECT_ID>');

const result = await mediaviz.projects.deleteProject('<PROJECT_ID>');

result = mediaviz.projects.delete_project('<PROJECT_ID>')

$result = $mediaviz->projects->deleteProject('<PROJECT_ID>');

curl -X DELETE 'https://api.mediaviz.ai/api/v1/projects/<PROJECT_ID>' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'