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

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shipping.taskArtifacts.s3Object.writeAiImageDescriptionV1("task_artifact_s3_object_metadata_id", {
        cargo_identity_assessment: "cargo_identity_assessment",
        completion_evidence: "completion_evidence",
        dispute_defensibility: "dispute_defensibility",
        location_description: "location_description",
        location_identifiers: [
            "location_identifiers",
        ],
        model: "gpt-6-astra",
        package_appearance: "package_appearance",
        package_types: [
            "package_types",
        ],
        proof_notes: [
            "proof_notes",
        ],
        readable_package_text: [
            "readable_package_text",
        ],
        summary: "summary",
    });
}
main();

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.

cargo_identity_assessmentstringRequired

completion_evidencestringRequired

dispute_defensibilitystringRequired

location_descriptionstringRequired

location_identifierslist of stringsRequired

modelenumRequired

package_appearancestringRequired

package_typeslist of stringsRequired

proof_noteslist of stringsRequired

readable_package_textlist of stringsRequired

summarystringRequired

package_countintegerOptional

schema_versionintegerOptionalDefaults to 1

searchable_factslist of stringsOptional

unresolved_questionslist of stringsOptional

Response

Successful Response

Errors

422

S3object Write AI Image Description V1request Unprocessable Entity Error