upload_instructions

imerit_ango.sdk.SDK.

upload_instructions(project_id, file_path, storage_id, bucket)

Upload an instruction file to your project.

Parameters

• project_id: string

  • The unique identifier for the project. You can find the project ID in the user interface or retrieve it using the list_projects function.

• file_path: string

  • Absolute path to the instruction file.

• storage_id: string, Optional, default None

  • The unique identifier for the storage. You can retrieve the storage ID using get_storages function.

• bucket: string, Optional, default None

  • The name of the storage bucket, or Azure container, to use for upload.

Returns:

• output: dict

  • A dictionary containing the result of the operation.

  • Including a status field indicating whether the request was successful and a data field containing the response payload with updated resources produced by the operation.

How to verify in Ango Hub?

After successfully executing the upload_instructions function, you can validate the changes directly in Ango Hub.

Navigate to: Projects → [Your Project] → Settings → Instructions

• Confirm that the instruction file has been uploaded successfully and is displayed correctly.

Changes made via the SDK are reflected in Ango Hub in near real-time. If updates are not immediately visible, please refresh the page.

Example

Upload an instruction file:

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

file_path = "/Users/user/Desktop/project_instruction.pdf"

sdk_response = ango_sdk.upload_instructions(project_id=project_id, file_path=file_path)

Upload an instruction file to a custom storage bucket or Azure container

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

file_path = "/Users/user/Desktop/project_instruction.pdf"
storage_id = "<Storage ID>"
bucket_name = "<Custom Bucket or Container Name>"

sdk_response = ango_sdk.upload_instructions(
    project_id=project_id,
    file_path=file_path,
    storage_id=storage_id,
    bucket=bucket_name
)

See also

get_project, Instructions