Write AI image description

PATCH

/shipping/task_artifacts/s3_object/ai_image_description/v1/:task_artifact_s3_object_metadata_id

PATCH

/shipping/task_artifacts/s3_object/ai_image_description/v1/:task_artifact_s3_object_metadata_id

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.shipping.taskArtifacts.s3Object.writeAiImageDescriptionV1("task_artifact_s3_object_metadata_id", {
8         model: "gpt-5.5",
9         summary: "summary",
10         package_types: [
11             "package_types",
12         ],
13         package_appearance: "package_appearance",
14         readable_package_text: [
15             "readable_package_text",
16         ],
17         cargo_identity_assessment: "cargo_identity_assessment",
18         location_description: "location_description",
19         location_identifiers: [
20             "location_identifiers",
21         ],
22         completion_evidence: "completion_evidence",
23         proof_notes: [
24             "proof_notes",
25         ],
26         dispute_defensibility: "dispute_defensibility",
27     });
28 }
29 main();

1 true

Writes the AI-generated image description onto an existing TaskArtifactS3ObjectMetadata. Called by the shipping_task_image_analysis Temporal workflow via a delegation JWT. | authz_personas=[driver_for_executor, executor_org_operators, shipper_org_operators, coordinator_org_operators] | (AIImageDescription) -> (bool)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

task_artifact_s3_object_metadata_idstringRequired

Request

This endpoint expects an object.

modelenumRequired

summarystringRequired

package_typeslist of stringsRequired

package_appearancestringRequired

readable_package_textlist of stringsRequired

cargo_identity_assessmentstringRequired

location_descriptionstringRequired

location_identifierslist of stringsRequired

completion_evidencestringRequired

proof_noteslist of stringsRequired

dispute_defensibilitystringRequired

schema_versionintegerOptionalDefaults to 1

package_countintegerOptional

searchable_factslist of stringsOptional

unresolved_questionslist of stringsOptional

Response

Successful Response

Errors

422

S3object Write AI Image Description V1request Unprocessable Entity Error