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>'
  }
);
const result = await mediaviz.projects.createProjectAndRun(
  '<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 mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS' \
  -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>'
  }
);
$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 mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

Check Project Status

Request Sample

const result = await mediaviz.projects.checkProjectStatus('<PROJECT_TABLE_NAME>');
const result = await mediaviz.projects.checkProjectStatus('<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 mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

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>');
$result = $mediaviz->projects->getProjectPrelimModelRequestTemplate('<PROJECT_TABLE_NAME>');
curl -X GET 'https://api.mediaviz.ai/api/v1/project_outcome/<PROJECT_TABLE_NAME>' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

Get User Projects

Request Sample

const result = await mediaviz.projects.getUserProjects();
const result = await mediaviz.projects.getUserProjects();
$result = $mediaviz->projects->getUserProjects();
curl -X GET 'https://api.mediaviz.ai/api/v1/projects/user' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

Get Admin Projects

Request Sample

const result = await mediaviz.projects.getAdminProjects();
const result = await mediaviz.projects.getAdminProjects();
$result = $mediaviz->projects->getAdminProjects();
curl -X GET 'https://api.mediaviz.ai/api/v1/projects/admin' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

Get Project By Id

Request Sample

const result = await mediaviz.projects.getProjectById('<PROJECT_ID>');
const result = await mediaviz.projects.getProjectById('<PROJECT_ID>');
$result = $mediaviz->projects->getProjectById('<PROJECT_ID>');
curl -X GET 'https://api.mediaviz.ai/api/v1/projects/<PROJECT_ID>' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

Get Project By Directory

Request Sample

const result = await mediaviz.projects.getProjectByDirectory('<DIRECTORY>');
const result = await mediaviz.projects.getProjectByDirectory('<DIRECTORY>');
$result = $mediaviz->projects->getProjectByDirectory('<DIRECTORY>');
curl -X GET 'https://api.mediaviz.ai/api/v1/projects/directory/{directory:path}' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

Update Project

Request Sample

const result = await mediaviz.projects.updateProject(
  '<PROJECT_ID>',
  '<PRIVATE_>',
  '<TYPE>',
  '<DESCRIPTION>',
  '<DIRECTORY>',
  '<NAME>',
  '<THUMBNAIL>'
);
const result = await mediaviz.projects.updateProject(
  '<PROJECT_ID>',
  '<PRIVATE_>',
  '<TYPE>',
  '<DESCRIPTION>',
  '<DIRECTORY>',
  '<NAME>',
  '<THUMBNAIL>'
);
$result = $mediaviz->projects->updateProject(
  '<PROJECT_ID>',
  '<PRIVATE_>',
  '<TYPE>',
  '<DESCRIPTION>',
  '<DIRECTORY>',
  '<NAME>',
  '<THUMBNAIL>'
);
curl -X PUT 'https://api.mediaviz.ai/api/v1/projects/<PROJECT_ID>' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS' \
  -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>'
  }
);
$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 mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

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>'
  }
);
$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 mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

Request Project Similarity Queue

Request Sample

const result = await mediaviz.projects.requestProjectSimilarityQueue('<PROJECT_TABLE_NAME>', '<LEVEL>');
const result = await mediaviz.projects.requestProjectSimilarityQueue('<PROJECT_TABLE_NAME>', '<LEVEL>');
$result = $mediaviz->projects->requestProjectSimilarityQueue('<PROJECT_TABLE_NAME>', '<LEVEL>');
curl -X GET 'https://api.mediaviz.ai/api/v1/projects_similarity_queue/<PROJECT_TABLE_NAME>/level/<LEVEL>' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

Request Project Evidence Queue

Request Sample

const result = await mediaviz.projects.requestProjectEvidenceQueue('<PROJECT_TABLE_NAME>');
const result = await mediaviz.projects.requestProjectEvidenceQueue('<PROJECT_TABLE_NAME>');
$result = $mediaviz->projects->requestProjectEvidenceQueue('<PROJECT_TABLE_NAME>');
curl -X GET 'https://api.mediaviz.ai/api/v1/projects_evidence_queue/<PROJECT_TABLE_NAME>' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

Request Project Personhood Queue

Request Sample

const result = await mediaviz.projects.requestProjectPersonhoodQueue('<PROJECT_TABLE_NAME>');
const result = await mediaviz.projects.requestProjectPersonhoodQueue('<PROJECT_TABLE_NAME>');
$result = $mediaviz->projects->requestProjectPersonhoodQueue('<PROJECT_TABLE_NAME>');
curl -X GET 'https://api.mediaviz.ai/api/v1/projects_personhood_queue/<PROJECT_TABLE_NAME>' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

Request Project Export

Request Sample

const result = await mediaviz.projects.requestProjectExport('<PROJECT_TABLE_NAME>');
const result = await mediaviz.projects.requestProjectExport('<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 mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

Get Project Data Export Upload Status

Request Sample

const result = await mediaviz.projects.getProjectDataExportUploadStatus('<PROJECT_TABLE_NAME>', '<MODEL_NAME>');
const result = await mediaviz.projects.getProjectDataExportUploadStatus('<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 mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

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>');
$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 mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS' \
  -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>');
$result = $mediaviz->projects->deleteProject('<PROJECT_ID>');
curl -X DELETE 'https://api.mediaviz.ai/api/v1/projects/<PROJECT_ID>' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'