Collections
Create Project And Run
Request Sample
const result = await mediaviz.projects.createProjectAndRun(
'<NAME>',
'<TYPE>',
'<PRIVATE_>',
'<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>',
'<TYPE>',
'<PRIVATE_>',
'<DESCRIPTION>',
'<DIRECTORY>',
'<PHOTO_UPLOAD_VECTOR>',
'<THUMBNAIL>',
'<RUN_NAME>',
{
outcomes: '<OUTCOMES>',
models: '<MODELS>'
}
);
const result = await mediaviz.projects.createProjectAndRun(
'<NAME>',
'<TYPE>',
'<PRIVATE_>',
'<DESCRIPTION>',
'<DIRECTORY>',
'<PHOTO_UPLOAD_VECTOR>',
'<THUMBNAIL>',
'<RUN_NAME>',
{
outcomes: '<OUTCOMES>',
models: '<MODELS>'
}
);
const { client } = useMediaViz();
const result = await client.projects.createProjectAndRun(
'<NAME>',
'<TYPE>',
'<PRIVATE_>',
'<DESCRIPTION>',
'<DIRECTORY>',
'<PHOTO_UPLOAD_VECTOR>',
'<THUMBNAIL>',
'<RUN_NAME>',
{
outcomes: '<OUTCOMES>',
models: '<MODELS>'
}
);
result = mediaviz.projects.create_project_and_run(
'<NAME>',
'<TYPE>',
'<PRIVATE_>',
'<DESCRIPTION>',
'<DIRECTORY>',
'<PHOTO_UPLOAD_VECTOR>',
'<THUMBNAIL>',
'<RUN_NAME>',
outcomes='<OUTCOMES>',
models='<MODELS>'
)
$result = $mediaviz->projects->createProjectAndRun(
'<NAME>',
'<TYPE>',
'<PRIVATE_>',
'<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
Response Sample
{
"name": "string",
"private": true,
"type": 0,
"description": "string",
"directory": "string",
"photo_upload_vector": 0,
"thumbnail": "string",
"run_name": "string",
"id": "string",
"user_id": 8507,
"company_id": 1024,
"active": true,
"project_table_name": "z-photos-1024-a1b2c3d4",
"date_created": "2025-01-15T10:30:00Z",
"number_of_photos": 0,
"date_photos_uploaded": "2025-01-15T10:30:00Z",
"date_deleted": "2025-01-15T10:30:00Z",
"top_tier": 0,
"tier_2": 0,
"total_photos_uploaded": 0,
"gsheet_view_link": "https://example.com/...",
"gsheet_csv_link": "https://example.com/...",
"gsheet_xlsx_link": "https://example.com/...",
"insights_view_link": "https://example.com/...",
"similarity_level": "string",
"blur_model": true,
"colors_model": true,
"face_recognition_model": true,
"image_classification_model": true,
"image_comparison_model": true,
"image_describe_model": true,
"ocr_model": true,
"similarity_model": true,
"personhood_model": true,
"evidence_model": true,
"insights_model": true,
"normalize": true,
"is_continuous_upload": true
}
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>'
}
);
const { client } = useMediaViz();
const result = await client.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>');
const { client } = useMediaViz();
const result = await client.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>');
const { client } = useMediaViz();
const result = await client.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();
const { client } = useMediaViz();
const result = await client.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'
Response Sample
[
{
"name": "string",
"private": true,
"type": 0,
"description": "string",
"directory": "string",
"photo_upload_vector": 0,
"thumbnail": "string",
"run_name": "string",
"id": "string",
"user_id": 8507,
"company_id": 1024,
"active": true,
"project_table_name": "z-photos-1024-a1b2c3d4",
"date_created": "2025-01-15T10:30:00Z",
"number_of_photos": 0,
"date_photos_uploaded": "2025-01-15T10:30:00Z",
"date_deleted": "2025-01-15T10:30:00Z",
"top_tier": 0,
"tier_2": 0,
"total_photos_uploaded": 0,
"gsheet_view_link": "https://example.com/...",
"gsheet_csv_link": "https://example.com/...",
"gsheet_xlsx_link": "https://example.com/...",
"insights_view_link": "https://example.com/...",
"similarity_level": "string",
"blur_model": true,
"colors_model": true,
"face_recognition_model": true,
"image_classification_model": true,
"image_comparison_model": true,
"image_describe_model": true,
"ocr_model": true,
"similarity_model": true,
"personhood_model": true,
"evidence_model": true,
"insights_model": true,
"normalize": true,
"is_continuous_upload": true
}
]
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();
const { client } = useMediaViz();
const result = await client.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'
Response Sample
[
{
"name": "string",
"private": true,
"type": 0,
"description": "string",
"directory": "string",
"photo_upload_vector": 0,
"thumbnail": "string",
"run_name": "string",
"id": "string",
"user_id": 8507,
"company_id": 1024,
"active": true,
"project_table_name": "z-photos-1024-a1b2c3d4",
"date_created": "2025-01-15T10:30:00Z",
"number_of_photos": 0,
"date_photos_uploaded": "2025-01-15T10:30:00Z",
"date_deleted": "2025-01-15T10:30:00Z",
"top_tier": 0,
"tier_2": 0,
"total_photos_uploaded": 0,
"gsheet_view_link": "https://example.com/...",
"gsheet_csv_link": "https://example.com/...",
"gsheet_xlsx_link": "https://example.com/...",
"insights_view_link": "https://example.com/...",
"similarity_level": "string",
"blur_model": true,
"colors_model": true,
"face_recognition_model": true,
"image_classification_model": true,
"image_comparison_model": true,
"image_describe_model": true,
"ocr_model": true,
"similarity_model": true,
"personhood_model": true,
"evidence_model": true,
"insights_model": true,
"normalize": true,
"is_continuous_upload": true
}
]
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>');
const { client } = useMediaViz();
const result = await client.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'
Response Sample
{
"name": "string",
"private": true,
"type": 0,
"description": "string",
"directory": "string",
"photo_upload_vector": 0,
"thumbnail": "string",
"run_name": "string",
"id": "string",
"user_id": 8507,
"company_id": 1024,
"active": true,
"project_table_name": "z-photos-1024-a1b2c3d4",
"date_created": "2025-01-15T10:30:00Z",
"number_of_photos": 0,
"date_photos_uploaded": "2025-01-15T10:30:00Z",
"date_deleted": "2025-01-15T10:30:00Z",
"top_tier": 0,
"tier_2": 0,
"total_photos_uploaded": 0,
"gsheet_view_link": "https://example.com/...",
"gsheet_csv_link": "https://example.com/...",
"gsheet_xlsx_link": "https://example.com/...",
"insights_view_link": "https://example.com/...",
"similarity_level": "string",
"blur_model": true,
"colors_model": true,
"face_recognition_model": true,
"image_classification_model": true,
"image_comparison_model": true,
"image_describe_model": true,
"ocr_model": true,
"similarity_model": true,
"personhood_model": true,
"evidence_model": true,
"insights_model": true,
"normalize": true,
"is_continuous_upload": true
}
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>');
const { client } = useMediaViz();
const result = await client.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'
Response Sample
{
"name": "string",
"private": true,
"type": 0,
"description": "string",
"directory": "string",
"photo_upload_vector": 0,
"thumbnail": "string",
"run_name": "string",
"id": "string",
"user_id": 8507,
"company_id": 1024,
"active": true,
"project_table_name": "z-photos-1024-a1b2c3d4",
"date_created": "2025-01-15T10:30:00Z",
"number_of_photos": 0,
"date_photos_uploaded": "2025-01-15T10:30:00Z",
"date_deleted": "2025-01-15T10:30:00Z",
"top_tier": 0,
"tier_2": 0,
"total_photos_uploaded": 0,
"gsheet_view_link": "https://example.com/...",
"gsheet_csv_link": "https://example.com/...",
"gsheet_xlsx_link": "https://example.com/...",
"insights_view_link": "https://example.com/...",
"similarity_level": "string",
"blur_model": true,
"colors_model": true,
"face_recognition_model": true,
"image_classification_model": true,
"image_comparison_model": true,
"image_describe_model": true,
"ocr_model": true,
"similarity_model": true,
"personhood_model": true,
"evidence_model": true,
"insights_model": true,
"normalize": true,
"is_continuous_upload": true
}
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>'
}
);
const { client } = useMediaViz();
const result = await client.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
Response Sample
{
"name": "string",
"private": true,
"type": 0,
"description": "string",
"directory": "string",
"photo_upload_vector": 0,
"thumbnail": "string",
"run_name": "string",
"id": "string",
"user_id": 8507,
"company_id": 1024,
"active": true,
"project_table_name": "z-photos-1024-a1b2c3d4",
"date_created": "2025-01-15T10:30:00Z",
"number_of_photos": 0,
"date_photos_uploaded": "2025-01-15T10:30:00Z",
"date_deleted": "2025-01-15T10:30:00Z",
"top_tier": 0,
"tier_2": 0,
"total_photos_uploaded": 0,
"gsheet_view_link": "https://example.com/...",
"gsheet_csv_link": "https://example.com/...",
"gsheet_xlsx_link": "https://example.com/...",
"insights_view_link": "https://example.com/...",
"similarity_level": "string",
"blur_model": true,
"colors_model": true,
"face_recognition_model": true,
"image_classification_model": true,
"image_comparison_model": true,
"image_describe_model": true,
"ocr_model": true,
"similarity_model": true,
"personhood_model": true,
"evidence_model": true,
"insights_model": true,
"normalize": true,
"is_continuous_upload": true
}
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>'
}
);
const { client } = useMediaViz();
const result = await client.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>'
}
);
const { client } = useMediaViz();
const result = await client.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>');
const { client } = useMediaViz();
const result = await client.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 Process Status
Request Sample
const result = await mediaviz.projects.getProjectProcessStatus('<PROJECT_TABLE_NAME>', '<MODEL_NAME>');
import type { AnalysisStatusResponse } from '@mediaviz/sdk';
const result: AnalysisStatusResponse = await mediaviz.projects.getProjectProcessStatus('<PROJECT_TABLE_NAME>', '<MODEL_NAME>');
const result = await mediaviz.projects.getProjectProcessStatus('<PROJECT_TABLE_NAME>', '<MODEL_NAME>');
const { client } = useMediaViz();
const result = await client.projects.getProjectProcessStatus('<PROJECT_TABLE_NAME>', '<MODEL_NAME>');
result = mediaviz.projects.get_project_process_status('<PROJECT_TABLE_NAME>', '<MODEL_NAME>')
$result = $mediaviz->projects->getProjectProcessStatus('<PROJECT_TABLE_NAME>', '<MODEL_NAME>');
curl -X GET 'https://api.mediaviz.ai/api/v1/projects/<PROJECT_TABLE_NAME>/process_status/<MODEL_NAME>' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoidXNyXzAxYWJjMTIzIiwiZXhwIjoxNzQzNjMwMzI5fQ.RwJF-KLLr8K5JgEtIeFiKWELcv-FDLNzMPHJ2St_wAo'
Response Sample
{
"project_table_name": "z-photos-1024-a1b2c3d4",
"model_or_process": "string",
"status": "string",
"last_updated_at": "2025-01-15T10:30:00Z"
}
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>');
const { client } = useMediaViz();
const result = await client.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>');
const { client } = useMediaViz();
const result = await client.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'