Codes
Python SDK reference for the codes resource
Note
Access this resource from client.codes. Both async and sync clients expose the same methods.
list
GET /graph/codes
result = await client.codes.list()Arguments:
optionsCodeQueryParams | NonequeryNoneCodeQueryParams
pageOptional[integer]page_sizeOptional[integer]order_byOptional['created_at' | 'updated_at']orderOptional['desc' | 'asc']user_idOptional[string]project_idOptional[string]project_slugOptional[string]networkOptional['eth' | 'bsc' | 'polygon' | 'base' | 'avax' | 'mode' | 'arb' | 'eth_sepolia' | 'bsc_test' | 'polygon_amoy' | 'base_sepolia' | 'avax_fuji' | 'mode_testnet' | 'arb_sepolia' | string]statusOptional['queued' | 'processing' | 'failed' | 'success']identifierOptional[string]with_paginationboolqueryFalseReturn type by call:
with_pagination=True→PaginatedResource[CodeMappingSchema]with_pagination=False→Pagination[CodeMappingSchema]
show properties (6)hide properties (6)
resultsarray of CodeMappingSchemashow properties (13)hide properties (13)
idstringrequirednetworkOptional['eth' | 'bsc' | 'polygon' | 'base' | 'avax' | 'mode' | 'arb' | 'eth_sepolia' | 'bsc_test' | 'polygon_amoy' | 'base_sepolia' | 'avax_fuji' | 'mode_testnet' | 'arb_sepolia']version_method'tag' | 'commit' | 'hash' | 'address'requiredversion_fingerprintstringrequiredstatus'queued' | 'processing' | 'failed' | 'success'requirednameOptional[string]branchOptional[string]commitOptional[GithubCommitSchema]show properties (4)hide properties (4)
shastringrequiredauthorstringrequiredmessagestringrequiredtimestampstringrequiredrepositoryOptional[GithubRepositorySchema]show properties (4)hide properties (4)
idintegerrequirednamestringrequiredis_privatebooleanrequiredaccountGithubAccountSchemarequiredshow properties (4)hide properties (4)
idintegerrequiredloginstringrequiredtypestringrequiredavatar_urlstringrequiredcreated_atstringrequiredproject_idstringrequiredproject_slugstringrequireduserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredpageintegerrequiredpage_sizeintegerrequiredmorebooleanrequiredtotal_observationsintegerrequiredtotal_pagesintegerrequiredget
GET /graph/codes/{code_id}
result = await client.codes.get(
code_id=code_id,
)Arguments:
code_idIDpathrequiredReturns: CodeMappingSchema
show properties (13)hide properties (13)
idstringrequirednetworkOptional['eth' | 'bsc' | 'polygon' | 'base' | 'avax' | 'mode' | 'arb' | 'eth_sepolia' | 'bsc_test' | 'polygon_amoy' | 'base_sepolia' | 'avax_fuji' | 'mode_testnet' | 'arb_sepolia']version_method'tag' | 'commit' | 'hash' | 'address'requiredversion_fingerprintstringrequiredstatus'queued' | 'processing' | 'failed' | 'success'requirednameOptional[string]branchOptional[string]commitOptional[GithubCommitSchema]show properties (4)hide properties (4)
shastringrequiredauthorstringrequiredmessagestringrequiredtimestampstringrequiredrepositoryOptional[GithubRepositorySchema]show properties (4)hide properties (4)
idintegerrequirednamestringrequiredis_privatebooleanrequiredaccountGithubAccountSchemarequiredshow properties (4)hide properties (4)
idintegerrequiredloginstringrequiredtypestringrequiredavatar_urlstringrequiredcreated_atstringrequiredproject_idstringrequiredproject_slugstringrequireduserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredtransitions
result = await client.codes.transitions(
body=body,
)Arguments:
bodyTransitionBodyDictbodyrequiredTransitionBodyDict
from_code_idstringrequiredto_code_idstringrequiredReturns: CodeVersionTransitionSchema
show properties (3)hide properties (3)
from_code_idstringrequiredto_code_idstringrequiredtransitionsarray of anyrequirededges
GET /graph/codes/{code_id}/edges
result = await client.codes.edges(
code_id=code_id,
)Arguments:
code_idIDpathrequiredReturns: ResultsResponse[GraphSnapshotEdge]
show properties (1)hide properties (1)
resultsarray of GraphSnapshotEdgeshow properties (16)hide properties (16)
idstringrequiredsrc_idstringrequireddst_idOptional[string]short_src_idstringrequiredshort_dst_idOptional[string]edge_type'uses' | 'typed_as' | 'modified_by' | 'calls' | 'calls_external' | 'reads' | 'writes' | 'inherits' | 'overrides' | 'emits' | 'throws' | 'defines' | 'initializes' | 'instantiates' | 'accesses' | 'has_constraint' | 'has_access_control' | 'references' | 'implements' | 'extends' | 'has_ref_comment' | 'has_condition'requiredsrc_start_posintegerrequiredcall_bindingsarray of CallBindingshow properties (7)hide properties (7)
param_indexintegerrequiredparam_namestringrequiredbound_to_node_idOptional[string]bound_to_nameOptional[string]is_known_storagebooleantype_nameOptional[string]bound_to_fieldOptional[string]src_field_namesarray of stringdst_field_namesarray of stringdirectionOptional['in' | 'out']is_conditionalbooleanrequiredinvoked_by_idOptional[string]low_level_nameOptional[string]src_node_typestringrequireddst_node_typeOptional[string]update
PATCH /graph/codes/{code_id}
result = await client.codes.update(
code_id=code_id,
name=name,
)Arguments:
code_idIDpathrequirednamestrbodyrequiredReturns: CodeMappingSchema
show properties (13)hide properties (13)
idstringrequirednetworkOptional['eth' | 'bsc' | 'polygon' | 'base' | 'avax' | 'mode' | 'arb' | 'eth_sepolia' | 'bsc_test' | 'polygon_amoy' | 'base_sepolia' | 'avax_fuji' | 'mode_testnet' | 'arb_sepolia']version_method'tag' | 'commit' | 'hash' | 'address'requiredversion_fingerprintstringrequiredstatus'queued' | 'processing' | 'failed' | 'success'requirednameOptional[string]branchOptional[string]commitOptional[GithubCommitSchema]show properties (4)hide properties (4)
shastringrequiredauthorstringrequiredmessagestringrequiredtimestampstringrequiredrepositoryOptional[GithubRepositorySchema]show properties (4)hide properties (4)
idintegerrequirednamestringrequiredis_privatebooleanrequiredaccountGithubAccountSchemarequiredshow properties (4)hide properties (4)
idintegerrequiredloginstringrequiredtypestringrequiredavatar_urlstringrequiredcreated_atstringrequiredproject_idstringrequiredproject_slugstringrequireduserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredretry
POST /graph/codes/{code_id}/retry
result = await client.codes.retry(
code_id=code_id,
)Arguments:
code_idIDpathrequiredReturns: CodeMappingSchema
show properties (13)hide properties (13)
idstringrequirednetworkOptional['eth' | 'bsc' | 'polygon' | 'base' | 'avax' | 'mode' | 'arb' | 'eth_sepolia' | 'bsc_test' | 'polygon_amoy' | 'base_sepolia' | 'avax_fuji' | 'mode_testnet' | 'arb_sepolia']version_method'tag' | 'commit' | 'hash' | 'address'requiredversion_fingerprintstringrequiredstatus'queued' | 'processing' | 'failed' | 'success'requirednameOptional[string]branchOptional[string]commitOptional[GithubCommitSchema]show properties (4)hide properties (4)
shastringrequiredauthorstringrequiredmessagestringrequiredtimestampstringrequiredrepositoryOptional[GithubRepositorySchema]show properties (4)hide properties (4)
idintegerrequirednamestringrequiredis_privatebooleanrequiredaccountGithubAccountSchemarequiredshow properties (4)hide properties (4)
idintegerrequiredloginstringrequiredtypestringrequiredavatar_urlstringrequiredcreated_atstringrequiredproject_idstringrequiredproject_slugstringrequireduserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredcreate_scan
POST /graph/codes/scan
result = await client.codes.create_scan(
body=body,
)Arguments:
bodyCodeScanBodyDictbodyrequiredCodeScanBodyDict
project_idstringrequirednetworkOptional[string]addressstringrequiredReturns: CodeMappingSchema
show properties (13)hide properties (13)
idstringrequirednetworkOptional['eth' | 'bsc' | 'polygon' | 'base' | 'avax' | 'mode' | 'arb' | 'eth_sepolia' | 'bsc_test' | 'polygon_amoy' | 'base_sepolia' | 'avax_fuji' | 'mode_testnet' | 'arb_sepolia']version_method'tag' | 'commit' | 'hash' | 'address'requiredversion_fingerprintstringrequiredstatus'queued' | 'processing' | 'failed' | 'success'requirednameOptional[string]branchOptional[string]commitOptional[GithubCommitSchema]show properties (4)hide properties (4)
shastringrequiredauthorstringrequiredmessagestringrequiredtimestampstringrequiredrepositoryOptional[GithubRepositorySchema]show properties (4)hide properties (4)
idintegerrequirednamestringrequiredis_privatebooleanrequiredaccountGithubAccountSchemarequiredshow properties (4)hide properties (4)
idintegerrequiredloginstringrequiredtypestringrequiredavatar_urlstringrequiredcreated_atstringrequiredproject_idstringrequiredproject_slugstringrequireduserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredcreate_paste
POST /graph/codes/paste
result = await client.codes.create_paste(
body=body,
)Arguments:
bodyCodePasteBodyDictbodyrequiredCodePasteBodyDict
project_idstringrequiredcontentstringrequiredReturns: CodeMappingSchema
show properties (13)hide properties (13)
idstringrequirednetworkOptional['eth' | 'bsc' | 'polygon' | 'base' | 'avax' | 'mode' | 'arb' | 'eth_sepolia' | 'bsc_test' | 'polygon_amoy' | 'base_sepolia' | 'avax_fuji' | 'mode_testnet' | 'arb_sepolia']version_method'tag' | 'commit' | 'hash' | 'address'requiredversion_fingerprintstringrequiredstatus'queued' | 'processing' | 'failed' | 'success'requirednameOptional[string]branchOptional[string]commitOptional[GithubCommitSchema]show properties (4)hide properties (4)
shastringrequiredauthorstringrequiredmessagestringrequiredtimestampstringrequiredrepositoryOptional[GithubRepositorySchema]show properties (4)hide properties (4)
idintegerrequirednamestringrequiredis_privatebooleanrequiredaccountGithubAccountSchemarequiredshow properties (4)hide properties (4)
idintegerrequiredloginstringrequiredtypestringrequiredavatar_urlstringrequiredcreated_atstringrequiredproject_idstringrequiredproject_slugstringrequireduserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredcreate_public_repo
POST /graph/codes/repo
result = await client.codes.create_public_repo(
body=body,
)Arguments:
bodyCodePublicRepoBodyDictbodyrequiredCodePublicRepoBodyDict
project_idstringrequiredurlstringrequiredReturns: CodeMappingSchema
show properties (13)hide properties (13)
idstringrequirednetworkOptional['eth' | 'bsc' | 'polygon' | 'base' | 'avax' | 'mode' | 'arb' | 'eth_sepolia' | 'bsc_test' | 'polygon_amoy' | 'base_sepolia' | 'avax_fuji' | 'mode_testnet' | 'arb_sepolia']version_method'tag' | 'commit' | 'hash' | 'address'requiredversion_fingerprintstringrequiredstatus'queued' | 'processing' | 'failed' | 'success'requirednameOptional[string]branchOptional[string]commitOptional[GithubCommitSchema]show properties (4)hide properties (4)
shastringrequiredauthorstringrequiredmessagestringrequiredtimestampstringrequiredrepositoryOptional[GithubRepositorySchema]show properties (4)hide properties (4)
idintegerrequirednamestringrequiredis_privatebooleanrequiredaccountGithubAccountSchemarequiredshow properties (4)hide properties (4)
idintegerrequiredloginstringrequiredtypestringrequiredavatar_urlstringrequiredcreated_atstringrequiredproject_idstringrequiredproject_slugstringrequireduserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredcreate_connected_repo
POST /graph/codes/connected-repo
result = await client.codes.create_connected_repo(
body=body,
)Arguments:
bodyCodeConnectedRepoBodyDictbodyrequiredCodeConnectedRepoBodyDict
project_idstringrequiredbranchOptional[string]commit_shaOptional[string]Returns: CodeMappingSchema
show properties (13)hide properties (13)
idstringrequirednetworkOptional['eth' | 'bsc' | 'polygon' | 'base' | 'avax' | 'mode' | 'arb' | 'eth_sepolia' | 'bsc_test' | 'polygon_amoy' | 'base_sepolia' | 'avax_fuji' | 'mode_testnet' | 'arb_sepolia']version_method'tag' | 'commit' | 'hash' | 'address'requiredversion_fingerprintstringrequiredstatus'queued' | 'processing' | 'failed' | 'success'requirednameOptional[string]branchOptional[string]commitOptional[GithubCommitSchema]show properties (4)hide properties (4)
shastringrequiredauthorstringrequiredmessagestringrequiredtimestampstringrequiredrepositoryOptional[GithubRepositorySchema]show properties (4)hide properties (4)
idintegerrequirednamestringrequiredis_privatebooleanrequiredaccountGithubAccountSchemarequiredshow properties (4)hide properties (4)
idintegerrequiredloginstringrequiredtypestringrequiredavatar_urlstringrequiredcreated_atstringrequiredproject_idstringrequiredproject_slugstringrequireduserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredgenerate_signing_key
POST /graph/codes/signing-key
result = await client.codes.generate_signing_key(
project_id=project_id,
)Arguments:
project_idIDbodyrequiredReturns: str
create_file
POST /graph/codes/file
result = await client.codes.create_file(
project_id=project_id,
files=files,
)Arguments:
project_idIDbodyrequiredfilesList[tuple[str, bytes]]bodyrequiredReturns: CodeMappingSchema
show properties (13)hide properties (13)
idstringrequirednetworkOptional['eth' | 'bsc' | 'polygon' | 'base' | 'avax' | 'mode' | 'arb' | 'eth_sepolia' | 'bsc_test' | 'polygon_amoy' | 'base_sepolia' | 'avax_fuji' | 'mode_testnet' | 'arb_sepolia']version_method'tag' | 'commit' | 'hash' | 'address'requiredversion_fingerprintstringrequiredstatus'queued' | 'processing' | 'failed' | 'success'requirednameOptional[string]branchOptional[string]commitOptional[GithubCommitSchema]show properties (4)hide properties (4)
shastringrequiredauthorstringrequiredmessagestringrequiredtimestampstringrequiredrepositoryOptional[GithubRepositorySchema]show properties (4)hide properties (4)
idintegerrequirednamestringrequiredis_privatebooleanrequiredaccountGithubAccountSchemarequiredshow properties (4)hide properties (4)
idintegerrequiredloginstringrequiredtypestringrequiredavatar_urlstringrequiredcreated_atstringrequiredproject_idstringrequiredproject_slugstringrequireduserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredupload_folder_zip
POST /graph/codes/folder
result = await client.codes.upload_folder_zip(
signing_key=signing_key,
zip_bytes=zip_bytes,
)Arguments:
signing_keystrbodyrequiredzip_bytesbytesbodyrequiredwith_streamingboolbodyFalseReturn type by call:
with_streaming=True→EventResource[CodeMappingSchema, CodeStatusEventData]with_streaming=False→CodeMappingSchema
show properties (13)hide properties (13)
idstringrequirednetworkOptional['eth' | 'bsc' | 'polygon' | 'base' | 'avax' | 'mode' | 'arb' | 'eth_sepolia' | 'bsc_test' | 'polygon_amoy' | 'base_sepolia' | 'avax_fuji' | 'mode_testnet' | 'arb_sepolia']version_method'tag' | 'commit' | 'hash' | 'address'requiredversion_fingerprintstringrequiredstatus'queued' | 'processing' | 'failed' | 'success'requirednameOptional[string]branchOptional[string]commitOptional[GithubCommitSchema]show properties (4)hide properties (4)
shastringrequiredauthorstringrequiredmessagestringrequiredtimestampstringrequiredrepositoryOptional[GithubRepositorySchema]show properties (4)hide properties (4)
idintegerrequirednamestringrequiredis_privatebooleanrequiredaccountGithubAccountSchemarequiredshow properties (4)hide properties (4)
idintegerrequiredloginstringrequiredtypestringrequiredavatar_urlstringrequiredcreated_atstringrequiredproject_idstringrequiredproject_slugstringrequireduserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredcreate_chat
POST /chats
result = await client.codes.create_chat(
code_id=code_id,
)Arguments:
code_idIDbodyrequiredReturns: ChatSchema
show properties (11)hide properties (11)
idstringrequiredcreated_atstringrequiredteam_idstringrequiredteam_slugstringrequiredproject_idstringrequiredproject_slugstringrequiredtotal_messagesintegerrequiredcode_idstringrequiredversion_idOptional[string]titleOptional[string]chat_type'code' | 'analysis'requiredScoped access
Calling client.codes(code_id) returns a resource scoped to that code, exposing the same nested resources listed here (.files, .nodes) pre-bound to it.

